Synchronization

Storage Connections

Download API definition:

POST https://sampleHostName/synchronization/imodels/storageConnections

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

Name
Required?
Description
Authorization
Yes

OAuth access token with scope synchronization:modify

Accept
No

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

Request body

storage-connection-create

Name
Type
Required?
Description
No data.

Response 201 Created

Connection successfully created.

json

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.

json

Response 409 Conflict

One or more SourceFiles are already mapped to the iModel.

json

Response 422 Unprocessable Entity

Invalid request to create connection. Request payload might be missing some of the required properties.

json

Response 429 Too many requests

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

json

Response headers

Name
Description
retry-after

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