iTwin Platform
Get Started
Documentation
Learning
Samples
Blog
Support
Pricing
Sign In
Free Trial
Table of contents
v1
REST API Overview
Overview
Samples
Reference
View All
Changelog
Documentation
Enterprise Data Federation Service (EDFS)
Enterprise Data Federation Service (EDFS)
Download API definition:
OpenAPI v3 (JSON)
API references
Call
Request URL
Title
Tags
POST
/edfs/itwins/{iTwinId}/packages/{uniqueName}/roles
Add package role to iTwin project role assignments
Permissions
POST
/edfs/itwins/{iTwinId}/timers
Create Timer
Triggers
POST
/edfs/itwins/{iTwinId}/systems
Create system
Systems
DELETE
/edfs/itwins/{iTwinId}/timers/{timerId}
Delete Timer
Triggers
DELETE
/edfs/itwins/{iTwinId}/systems/{id}
Delete system
Systems
POST
/edfs/itwins/{iTwinId}/packages/{uniqueName}
Execute package
Packages
GET
/edfs/packages/roles
Get available EDFS package roles
Permissions
GET
/edfs/itwins/{iTwinId}/packages/{uniqueName}/odata
Get entity sets
OData
GET
/edfs/itwins/{iTwinId}/timers
Get list of timers
Triggers
GET
/edfs/itwins/{iTwinId}/packages/{uniqueName}/odata/$metadata
Get metadata
OData
GET
/edfs/packages/{uniqueName}
Get package details
Packages
GET
/edfs/itwins/{iTwinId}/packages/{uniqueName}/roles
Get package role to iTwin project role assignments
Permissions
GET
/edfs/itwins/{iTwinId}/packages/{uniqueName}/systems/{systemType}
Get package system type properties
Packages
GET
/edfs/itwins/{iTwinId}/packages/{uniqueName}/systems
Get package system types
Packages
GET
/edfs/packages
Get subscribed packages
Packages
GET
/edfs/itwins/{iTwinId}/systems
Get systems
Systems
GET
/edfs/itwins/{iTwinId}/packages/{uniqueName}/odata/{entitySet}[?$select][&$filter][&$orderby][&$skip][&$top]
Get the data for the entity set
OData
GET
/edfs/itwins/{iTwinId}/timers/{timerId}
Get timer
Triggers
PATCH
/edfs/itwins/{iTwinId}/packages/{uniqueName}/roles
Patch package role to iTwin project role assignments
Permissions
PUT
/edfs/itwins/{iTwinId}/packages/{uniqueName}/roles/remove-itwin-roles
Remove all package role assignments for specified iTwin roles
Permissions
PUT
/edfs/itwins/{iTwinId}/packages/{uniqueName}/roles/remove-assignments
Remove selected package role to iTwin project role to assignments
Permissions
PATCH
/edfs/itwins/{iTwinId}/timers/{timerId}/toggle
Toggle timer
Triggers
PUT
/edfs/itwins/{iTwinId}/systems/{id}
Update system
Systems
Was this page helpful?
Yes
No