This endpoint is used to create a configuration for Merge iModel transformation.
Merge iModel transformation is used for synchronizing changes between fork and main iModels in either direction.
Merge iModel transformation should be used to synchronize changes between main and fork iModels created using "Fork iModel" operation in iModels API whereas Merge Fork should be used with forks created using one of Create Fork, Filter IModel, Filter SubCategories, Filter By View Definition transformations.
Note: Creating a configuration does not run the transformation. To run the transformation, please see transformations reference.
Merge iModel transformation requirements
iModel fork must be created using Fork iModel operation in iModels API. Additionally, all elements in both fork and main iModels must have FederationGuid
property set to a non null
value. If that is not the case, PopulateFederationGuids transformation can be used to set missing FederationGuid
values.
Merge direction
Source and target (project & iModel) properties mark the data flow direction:
- If
sourceIModelId
is iModel fork andtargetIModelId
is main iModel, it means that iModel fork is being merged to main iModel. - If
sourceIModelId
is main iModel andtargetIModelId
is iModel fork, it means that main iModel is being merged to iModel fork.
Running consecutive transformations for this configuration will keep synchronizing newly added changes in the specified direction.
Transformation state persistence in iModel fork
In addition to exported data, the transformer will also push some additional metadata to iModel fork. This metadata contains:
BisCore:RepositoryLink
andBisCore:ExternalSource
elements that mark the source where the data was imported from.- A "Scope"
BisCore:ExternalSourceAspect
that contains Synchronization changeset metadata that is needed by the transformation service to process any later changes correctly.
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 page.
Authorization
You must have imodels_write
assigned at the target project level and imodels_read
assigned at the source project level within related configuration. If permissions at the project level are not configured, then you must have same assigned at the iModel level.
Alternatively, you must be an Organization Administrator for the Organization that owns a given project the iModel belongs to.
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 see Bentley Communities Licensing, Cloud, and Web Services wiki page.
Important: Merge iModel transformation is in closed preview mode currently and only selected applications can utilize it.
Rate limits
All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.