Enterprise Data Federation Service (EDFS or EDF) is a set of iTwin integration services designed to enable integration of Bentley iTwin platform solutions with any external enterprise system or user solutions (such as SAP®, IBM® Maximo™, Microsoft® SharePoint, ESRI, etc.). EDFS is the latest generation (6th) of BECS integration engine.
EDFS is designed to support any requested integration by running any EDFS integration package from Bentley Integration Catalogue (BIC). Thanks to this flexibility and zero coding needed for design or maintenance of integration packages is easy to adapt any integration request.
Main mission of EDFS is to provide zero coding, ready to use, Bentley catalogue based integration gateway to any user enterprise system or solution.

edfs

---

Get OData entity sets for the integration package.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the EDFS `Execute Integration Package` role assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.
Package role assignments can be set
- By [setting integration package roles](/apis/edfs/operations/packages-roles-assignments-add/)

---

packages-uniqueName-itwins-iTwinId-odata

iTwinId

uniqueName

Content-Type

OAuth access token with `itwin-platform` scope

Authorization

Setting to `application/vnd.bentley.itwin-platform.v1+json` is recommended.

Accept

default

This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.

HeaderNotFound

InvalidAuthorizationScheme

InvalidHeaderValue

RequiredScopeMissing

Unauthorized

InvalidApplicationTier

This response indicates iTwin or integration package was not found.

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)

This response indicates that the user has sent too many requests in a given amount of time.

The number of requests exceeds the rate-limit for the client subscription.

retry-after

---

Get OData metadata for the integration package.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the EDFS `Execute Integration Package` role assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.
Package role assignments can be set
- By [setting integration package roles](/apis/edfs/operations/packages-roles-assignments-add/)

---

packages-uniqueName-itwins-iTwinId-odata-metadata

---

Retrieve Entity Collections or Individual Entity by ID. To retrieve Entity Collections use `/entitySet`. To retrieve Individual Entity by ID use `/entitySet(key)`.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the EDFS `Execute Integration Package` role assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.
Package role assignments can be set
- By [setting integration package roles](/apis/edfs/operations/packages-roles-assignments-add/)

---

packages-uniqueName-itwins-iTwinId-odata-entitySet

entitySet

Requests a specific set of properties for each entity using OData syntax

$select

Filter a collection of resources that are addressed using OData syntax.

$filter

Request resources in a particular order using OData syntax.

$orderby

Requests the number of items in the queried collection that are to be skipped and not included in the result.

$skip

Requests the number of items in the queried collection to be included in the result.

$top

---

Execute the specified integration package for the specified iTwin. Other integration package specific variables can be provided in the body.

To get an example of input for each integration package you can retrieve the details
- By [getting details of subscribed integration package](/apis/edfs/operations/subscribed-packages-details-get/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the EDFS `Execute Integration Package` role assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.
Package role assignments can be set
- By [setting integration package roles](/apis/edfs/operations/packages-roles-assignments-add/)

---

execute-post

The user has insufficient permissions for the requested operation.

---

Retrieve details of the currently subscribed integration package by organization.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_projmng` permission assigned at the Organizational level or be an Organization Administrator.

---

subscribed-packages-details-get

This response indicates integration package was not found.

---

Retrieve external system type and external system type credential properties for the integration package.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_credmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

system-type-properties-get

systemType

This response indicates iTwin, integration package or system type was not found.

---

Retrieve external systems used by the integration package.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_credmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

system-types-get

---

Retrieve a list of currently subscribed integration packages by organization.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_projmng` permission assigned at the Organizational level or be an Organization Administrator.

---

subscribed-packages-get

---

Adds new integration package role to iTwin project role assignments for the integration package.

You can retrieve the available packageRoleIds
- By [getting integration package roles](/apis/edfs/operations/packages-roles-get/)

You can retrieve the available iTwinRoleIds for your iTwin project
- By [getting iTwin roles](/apis/access-control-v2/operations/get-iTwin-roles/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page.

User must also have the following permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin:
- `edfs_ilsmng` to Manage Access to specific Integration Packages
	
Each integration package role has its own permission(s) assigned and the user who wants to manage them must have these permissions assigned as well.

__Package roles and associated permissions__
- Execute Integration Package
	- `edfs_objipexec` to Execute Integration Package(s)

---

packages-roles-assignments-add

---

Retrieve information about the currently available integration package roles assignable to iTwin roles for the integration package.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page.

User must also have the following permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin:
- `edfs_ilsmng` to Manage Access to specific Integration Packages

---

packages-roles-get

---

Retrieve information about the current integration package role to iTwin role assignments for this integration package.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page.

User must also have the following permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin:
- `edfs_ilsmng` to Manage Access to specific Integration Packages

---

packages-roles-assignments-get

---

Patch existing integration package role to iTwin project role to assignments for the integration package.

You can add integration package role to new iTwin project role
- By [Adding package role to iTwin project role assignments](/apis/edfs/operations/packages-roles-assignments-add/).

You can retrieve the available packageRoleIds
- By [getting integration package roles](/apis/edfs/operations/packages-roles-get/)

You can retrieve the available iTwinRoleIds for your iTwin project
- By [getting iTwin roles](/apis/access-control-v2/operations/get-iTwin-roles/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page.

User must also have the following permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin:
- `edfs_ilsmng` to Manage Access to specific Integration Packages
	
Each integration package role has its own permission(s) assigned and the user who wants to manage them must have these permissions assigned as well.

__Package roles and associated permissions__
- Execute Integration Package
	- `edfs_objipexec` to Execute Integration Package(s)

---

packages-roles-assignments-patch

---

Remove all existing integration package role assignments for specified iTwin roles for the integration package.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page.

User must also have the following permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin:
- `edfs_ilsmng` to Manage Access to specific Integration Packages
	
Each integration package role has its own permission(s) assigned and the user who wants to manage them must have these permissions assigned as well.

__Package roles and associated permissions__
- Execute Integration Package
	- `edfs_objipexec` to Execute Integration Package(s)

---

packages-roles-assignments-remove-all

---

Remove only the specified integration package role to iTwin project role assignments for the integration package.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must be an Organization Administrator for the Organization that owns a given Project or have `administration_manage_roles` permission assigned at the Project level.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities [Licensing, Cloud, and Web Services](https://bentleysystems.service-now.com/community?id=kb_article_view&sys_kb_id=1e5410491b7d8a90f3fc5287624bcb57) wiki page.

User must also have these permissions assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.
- `edfs_ilsmng` to Manage Access to specific Integration Packages
	
Each integration package role has its own permission(s) assigned and the user who wants to manage them must have these permissions assigned as well.

__Package roles and associated permissions__
- Execute Integration Package
	- `edfs_objipexec` to Execute Integration Package(s)

---

packages-roles-assignments-remove-selected

---

Create external system information and its credentials set.

You need to provide the `SystemId` (unique within the integration package) and the `SystemType`. You can retrieve them
- By [getting integration package system types](/apis/edfs/operations/system-types-get/)

You also need to provide the `credentials`. These are system properties (different for each system type). You can retrieve them
- By [getting integration package system type properties](/apis/edfs/operations/system-type-properties-get/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_credmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

credentials-set-post

Development Sql Server

This response indicates that the user tried to create a resource that already exists.

---

Delete external system information and its credentials set.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_credmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

credentials-set-delete

This response indicates iTwin or system was not found.

---

Retrieve a list of the external systems belonging to iTwin. This will retrieve only metadata. Credential values will not be retrieved.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_credmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

credentials-sets-get

This response indicates iTwin was not found.

---

Update external system information and its credentials set.

You need to provide the `SystemId` (unique within the integration package) and the `SystemType`. You can retrieve them
- By [getting integration package system types](/apis/edfs/operations/system-types-get/)

You also need to provide the `credentials`. These are system properties (different for each system type). You can retrieve them
- By [getting integration package system type properties](/apis/edfs/operations/system-type-properties-get/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_credmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

credentials-set-put

---

Insert integration package timer.

You need to provide the `packageUniqueName` which is the uniqueName of the integration package the Organization that owns a given iTwin is subscribed to.
You need to provide the `cronStr` that represents the cron expression (a cron expression is a string consisting of six or seven subexpressions/fields that define a schedule). The integration package will be executed according to this schedule.
You need to provide the `parameters`. Parameters are input variables for the integration package. To get an example of the input for each integration package you can retrieve the details
- By [getting details of subscribed integration package](/apis/edfs/operations/subscribed-packages-details-get/)

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_listmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

timer-post

SAP_WORK_ORDERS at 00:00 on Saturday and Sunday

---

Delete integration package timer.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_listmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

timer-delete

timerId

This response indicates iTwin or timer was not found.

---

Retrieve a list of integration package timers.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_listmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

timers-get

---

Retrieve details of the specified integration package timer.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_listmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

timer-get

---

Enable or disable integration package timer.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Authorization

User must have the `edfs_listmng` permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.

---

Samples