iModel Connections API is a cloud-based synchronization API meant to synchronize the data in Input Files and iModels. It allows users to establish links from their design files to iModels, hosted in Bentley's iModelHub. Users can synchronize updates to their design files.

synchronization

Added technology preview operation 'Patch Connection Configurations'.

Added technology preview operation 'Patch iModel Configurations'.

Added technology preview operation 'Patch iTwin Configurations'.

Added technology preview operation 'Get Connection Configurations'.

Added technology preview operation 'Get iTwin Configurations'.

Added technology preview operation 'Get iModel Configurations'.

Added technology preview operation 'Create Connection Configurations'.

Added technology preview operation 'Delete Connection Configurations'.

Added technology preview operation 'Create iModel Configurations'.

Added technology preview operation 'Delete iModel Configurations'.

Added technology preview operation 'Create iTwin Configuration'.

Added technology preview operation 'Delete iTwin Configuration'.

Added technology preview operation 'Get Manifest Connections'.

Added new property describing the connector type to Manifest Connections, Create ManifestConnection Run. The new property `connectorType` will replace `connector` property. 
**The property `connector` will be deprecated!**

Added technology preview operation 'Get ManifestConnection Runs'.

Added technology preview operation 'Get ManifestConnection SourceFile'.

Added technology preview operation 'Update ManifestConnection SourceFile'.

Added technology preview operation 'Update ManifestConnection'.

Added technology preview operation 'Get ManifestConnection SourceFiles'.

Added technology preview operation 'Add ManifestConnection SourceFile'.

Added technology preview operation 'Remove ManifestConnection SourceFile'.

This information is included in every event the webhook will receive.

base-event

content

object

eventType

string

enqueuedDateTime

iTwinId

messageId

webhookId

Base Event

Event that gets triggered when a synchronization job is complete

synchronization.jobCompleted.v1-event

Globally Unique Identifier of the synchronization.

synchronizationId

Globally Unique Identifier of the iModel.

iModelId

Globally Unique Identifier of the connection.

connectionId

result

synchronization.jobCompleted.v1

---

Retrieves the calling user's AuthorizationInformation.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-authorization-information

URL to redirect back to after authorization

redirectUrl

OAuth access token with `synchronization:read` or `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

application/json;InvalidAuthorizationScheme

InvalidAuthorizationScheme

InvalidHeaderValue

RequiredScopeMissing

Unauthorized

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

---

Create a configuration that defines how data is processed and synced to iModels with the specific connection.

### Configurations

#### reclassifyDgnElements

Enables connector to change the base class of an element if its current classification comes from the Generic schema.
The default value is false.

If this configuration is set to true:

- Every Generic element in the model will be re-processed, so expect a longer synchronization job.
- Elements that are derived from a BIS class will not be processed.
- Elements that did not change in the source file may appear modified in iModel if you use the Changed Elements API.
- Elements that changed will appear deleted and added in iModel if you use the Changed Elements API.
- Suggest setting this configuration with caution and per required run basis, not perpetual.

Use case example: If you have been advised by Bentley support that the Connector has added additional support for your files' disciplines (e.g. additional BIS schema alignment), then this option should be enabled on the next run to opt-in to the updated alignment.

#### ignoreDgnAttachments

Enables skipping of all reference attachments. As a result, only the master file is synchronized into the iModel. Only applicable for .dgn and .dwg files.
The default value is false.

A reference file could have a transform/ level override/ symbology override when attached through a master file. None of these settings will be available if the files are processed individually and could result in data not matching the intended design.

#### enableSheetsAndDrawings 

Controls sheets and drawings synchronization. If enabled all sheet models and relayed drawings will be synchronized to an iModel.
The default value is false.

#### enableC3dGraphsIn2dModel

Enables the separation of 2D elements from 3D elements in the target iModel when using Civil Connector. The 2D elements will be inserted into a graph model, while the 3D elements will be kept in the spatial model. The default value is false.

Standard AutoCAD 2D entities, such as MTEXT, LINE, POLYLINE, etc., laid on the XY plane in the model space, will be converted as 2D elements and inserted into the graph model. This feature flag does not impact alignments and their labels, which always stay in the spatial model.

If the file contains only AutoCAD entities and no Civil3D entities or has Civil3D model entities but no 2D graphics, we suggest leaving this configuration as false.

#### enableSheetIndex

A sheet index is a centralized and structured collection of sheets in your WorkSet. Enabling this flag triggers processing of sheet index files from the associated workspace.The default value is false.

Use case example: Sheet index can be useful in creating a construction document set. So a civil user might be interested in turning on this flag to get the content of the sheets he has configured.

#### filterBySheetIndex

A sheet index is a centralized and structured collection of sheets in your WorkSet. Enabling this flag limits (filters) the processing of sheets provided to the connector to the ones specified in the sheet index. The default value is false.

Use case example: Sheet index can be useful in creating a construction document set. However, there could be large number of sheets present in the input set and the user may be only interested in the ones specified by the sheet index. Enabling this flag allows such filtering.
### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


create-connection-configuration

connectionid

OAuth access token with `synchronization:modify` or `itwin-platform` scope

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

application/json;InvalidConfigurationRequest

InvalidConfigurationRequest

MissingRequestBody

---

Create a configuration that defines how data is processed and synced to iModels in the specific iModel.

### Configurations

#### clampZExtent

Enables a limit for the project Z extent maximum up to Mount Everest height (i.e.8849 meters). Works only when project extent in XY direction is defined for iModel.
The default value is false.

Display performance can be adversely affected if source data is poorly aligned or contains elements far from the project's physical location. If files cannot be corrected, this configuration would help viewers to restrict the Z extent.

Use case example: allows restricting viewport to the bounding box so that any arbitrary geometry far away from the actual design does not impact fitting the model to the viewport.

#### overrideRvtReprojectionDistance

Define distance in meters when to start ignoring .rvt file geo-location data and reprojecting graphics based on local iModel coordinates.
The default value is 0.

Reprojection happens when the .rvt file and iModel have different geographic coordinate systems. If the distance between both GCS is bigger than the number provided with the flag, reprojection will be skipped, and no errors will be reported. Otherwise, reprojection will be applied.
This configuration will have no effect if Revit was the first file synchronized to an empty iModel.

Use case example: no reprojection of Revit file is needed beyond some pre-defined radius.
### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


create-imodel-configuration

imodelid

---

Create a configuration that defines how data is processed and synced to iModels in the specific iTwin.

### Configurations

#### uploadDgnRealityData

Enables reality data upload to Reality Data API while synchronizing files to iModels, if .3sm, .3mx, .pod, or raster attachments are attached to CAD data.
The default value is true.

Having this configuration set to true will trigger credit usage for Reality Data service.

#### convertDgnTerrainModels

Enables terrain model elements to be processed during dgn-based synchronizations.
The default value is false.

#### squashIntermediateRevisions

Enables the creation of a single Changeset for physical and drawing elements (2D, 3D) coming from all Source Files. Separate Changesets will be pushed for any schema or definition changes.
The default value is false.

Use case example: minimize a linear timeline of the iModel changes. However, in this case, you would not be able to get information on individual Source File changes.

#### convertDgnHyperModelingSections

Enables displaying the 2D section graphics and annotations in the context of the 3D model.
The default value is true.

Use case example: typical design files include hypermodels, and the intent is to expose such information in a viewer. Refer to the sample of how to navigate between the 2D and 3D views easily: [sample](https://www.itwinjs.org/sandboxes/iTwinPlatform/Hyper-modeling) 

#### skipRvtReprojection

Ignores geo-location defined in .rvt file and overlaps the model at the local iModel coordinates.
The default value is false.

This configuration will have no effect if Revit was the first file synchronized to an empty iModel.

Use case example: multiple Revit files will need to be synchronized; if individual files are not aligned to the exact location, this configuration will bring all the models to the same place. However, we suggest enhancing the original design files with proper geographic coordinate systems before synchronization instead of using this configuration.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


create-itwin-configuration

itwinid

---

Delete a specified configuration based on the provided connection Id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-connection-configuration

This response indicates that the specified configuration was not found.

Invalid request to delete a configuration.

---

Delete a specified configuration based on the provided iModel Id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-imodel-configuration

---

Delete a specified configuration based on the provided iTwin Id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


delete-itwin-configuration

---

Retrieves a configuration based on the provided connection Id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-connection-configuration

---

Retrieves a configuration based on the provided iModel Id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-imodel-configuration

---

Retrieves a configuration based on the provided iTwin Id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-itwin-configuration

---

Patches a Configuration based on the provided connection Id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

patch-connection-configuration

---

Patches a configuration based on the provided iModel Id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

patch-imodel-configuration

---

Patches a configuration based on the provided iTwin Id.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

patch-itwin-configuration

Invalid request to patch a configuration. Request payload might be missing some of the required properties.

---

Retrieves connections for the specified iModel.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-connections

imodelId

The [$top](https://www.odata.org/getting-started/basic-tutorial/#topskip) system query option requests the number of items in the queried collection to be included in the result.

$top

The [$skip](https://www.odata.org/getting-started/basic-tutorial/#topskip) query option requests the number of items in the queried collection that are to be skipped and not included in the result.

$skip

minimal

representation

This response indicates that the specified iModel was not found.

---

Add a new Manifest Source File to a Manifest Connection

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities
SourceFile is added to a Connection. The reuqest path must contain a valid Connection ID

---


add-manifest-connection-sourcefile

Manifest Connection sourceFile successfully added.

This response indicates that the specified connection sourceFile was not found.

The SourceFile is already mapped to the iModel.

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

application/json;InvalidManifestConnectionSourceFileRequest

InvalidManifestConnectionSourceFileRequest

---

Retrieves ManifestConnection's SourceFile with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-manifest-connection-sourcefile

sourceFileId

Invalid request to get connection sourceFile.

---

Retrieves SourceFiles for specified ManifestConnection.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-manifest-connection-sourcefiles

This response indicates that the specified connection was not found.

Invalid request to get connection sourcefiles.

---

Delete ManifestConnection SourceFile

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.


---


remove-manifest-connection-sourcefile

This response indicates that one of the associated entities could not be found.

Invalid request to remove connection sourcefile.

---

Update an existing StorageConnection SourceFile.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities
SourceFile is related to a Connection. The path must contain a valid Connection ID.

---


update-manifest-connection-sourcefile

Connection sourceFile successfully updated.

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

---

Create a ManifestConnection that describes which files from a manifest will be synchronized to the iModel.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities

A connection is linked with an iModel. An iModel ID is required to be set when creating a ManifestConnection.

---


create-manifest-connection

One or more SourceFiles are already mapped to the iModel.

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

application/json;InvalidManifestConnectionRequest

InvalidManifestConnectionRequest

---

Runs the specified ManifestConnection.

### Notes

When a run is successfully created, the operation returns HTTP status code 202/accepted - the request is accepted for processing and will execute in background. The response will include a location header pointing to the created run. If an existing active run already exists for the iModel, a new run is not initiated, instead 303/see other is returned along with location header pointing to that existing active run. 
In the rare event that multiple create run requests are being made simultaneously, only the first request is processed and 409/conflict is returned for others.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

create-manifest-connection-run

Location

This response indicates that an active run is in progress and link is provided in location header.

This response indicates that user does not have required permissions to run specified connection.

A run request is already being processed.

Invalid request to create a connection run.

application/json;InvalidManifestConnectionRunRequest

InvalidManifestConnectionRunRequest

---

Delete connection

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.


---


delete-manifest-connection

---

Retrieves a ManifestConnection with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-manifest-connection

Invalid request to get a manifest connection.

---

Retrieves a ManifestConnection Run with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-manifest-connection-run

runId

This response indicates that the specified connection run was not found.

---

Retrieves all Runs for the specified connection.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-manifest-connection-runs

---

Retrieves Manifest Connections for the specified iModel.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-manifest-connections

Invalid request to get manifest connections.

---

Update an existing ManifestConnection.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities

The Connection ID is required to be set when updating a ManifestConnection.

---


update-manifest-connection

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

---

Add a new Storage Source File to a Storage Connection

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities
SourceFile is added to a Connection. The reuqest path must contain a valid Connection ID

---


add-storage-connection-sourcefile

Storage Connection sourceFile successfully added.

This response indicates that user does not have required permissions to create specified connection sourcefile.

application/json;InvalidStorageConnectionSourceFileRequest

InvalidStorageConnectionSourceFileRequest

---

Retrieves StorageConnection's SourceFile with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-storage-connection-sourcefile

Invalid request to get connection sourcefile.

---

Retrieves SourceFiles for specified StorageConnection.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-storage-connection-sourcefiles

---

Delete StorageConnection SourceFile

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.


---


remove-storage-connection-sourcefile

This response indicates that user does not have required permissions to delete specified connection.

update-storage-connection-sourcefile

---

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` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities

A connection is linked with an iModel. An iModel ID is required to be set when creating a StorageConnection.

---


create-storage-connection

application/json;InvalidStorageConnectionRequest

InvalidStorageConnectionRequest

---

Runs the specified StorageConnection.

### Notes

When a run is successfully created, the operation returns HTTP status code 202/accepted - the request is accepted for processing and will execute in background. The response will include a location header pointing to the created run. If an existing active run already exists for the iModel, a new run is not initiated, instead 303/see other is returned along with location header pointing to that existing active run. 
In the rare event that multiple create run requests are being made simultaneously, only the first request is processed and 409/conflict is returned for others.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

run-storage-connection

delete-storage-connection

---

Retrieves a StorageConnection with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-storage-connection

---

Retrieves a StorageConnection Run with the specified ID.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---

get-storage-connection-run

get-storage-connection-runs

This response indicates that the specified connection not found.

---

Retrieves Storage Connections for the specified iModel.

### Notes

The `Prefer` header can be used to specify how much result metadata is desired by the client. The `Prefer` request header field is used to indicate that particular server behaviors are preferred by the client but are not required for successful completion of the request.

This operation supports `"return=representation"` and `"return=minimal"` preferences.

The `"return=representation"` preference indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
The `"return=minimal"` preference indicates that the client wishes the server to return only a minimal response to a successful request. This is the default preference if `Prefer` header is not specified.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:read` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

---


get-storage-connections

Invalid request to get storage connections.

---

Update an existing StorageConnection.

### Authentication

Requires `Authorization` header with valid Bearer token for scope `synchronization:modify` or `itwin-platform`.

For more documentation on authorization and how to get access token visit [OAUTH2 Authorization](https://developer.bentley.com/apis/overview/authorization/) page.

### Associated entities

A connection is linked with an iModel. The iModel ID is required to be set when updating a StorageConnection.

---


update-storage-connection

Changelog - Synchronization | iTwin Platform

Walk-through how to synchronize a file from iTwin Storage to an iModel using Synchronization API.

Synchronize a file from iTwin Storage

An introduction to Synchronization Configurations API explaining main workflows and operations.

Get started with Synchronization Configurations API

Walk-through how to synchronize a file from Azure Blob Storage to an iModel using Synchronization API.

Synchronize a file from Azure Blob Storage

Walk-through how to unmap an Azure Blob Storage file from an iModel using Synchronization API.

Changelog

Oct 24, 2022

Oct 21, 2022

Oct 18, 2022

Oct 17, 2022

Oct 12, 2022

Oct 3, 2022

Sep 27, 2022

Sep 15, 2022

Jun 20, 2022

Jun 15, 2022

May 26, 2022

May 10, 2022

Apr 27, 2022

Apr 13, 2022

Apr 7, 2022