Synchronization
Storage Connections
Create a StorageConnection that describes files from Storage to synchronize to the iModel.
Authentication
Requires Authorization header with valid Bearer token for scope synchronization:modify.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Associated entities
A connection is linked with an iModel. An iModel ID is required to be set when creating a StorageConnection.
Request headers
OAuth access token with scope synchronization:modify
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
A type used for defining authorization workflow for this connection. Default is user.
A storage connection display name.
iModel id.
Example
Response 401 Unauthorized
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.
Response 422 Unprocessable Entity
Invalid request to create connection. Request payload might be missing some of the required properties.
Response 429 Too many requests
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.
Storage Connection
A type used for defining authorization workflow for this connection. Default is user.
Storage connection id.
A storage connection display name.
iModel id.
Storage Connection (create)
A type used for defining authorization workflow for this connection. Default is user.
A storage connection display name.
iModel id.
StorageFile (create)
Storage file id.
Type of connector used for synchronization. Refer supported connector format for details.
Link
Hyperlink to the specific entity.
Connector type
One of 'AUTOPLANT', 'CIVIL', 'CIVIL3D', 'DWG', 'GEOSPATIAL', 'IFC', 'MSTN', 'NWD', 'OBD', 'OPENTOWER', 'REVIT', 'SPPID', 'SPXREVIEW'. Name of the Connector that is used for synchronization.
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.