Configurations

This endpoint allows to create a configuration for merge fork transformation.

MergeFork transformation allows to merge back the forked iModel into the main iModel. Forked iModel must be created using one of CreateFork, FilterIModel, FilterSubCategories, FilterByViewDefinition transformation and it must have at least one new changeset with modifications for merging to succeed.

To configure MergeFork configuration correctly, you will need to pass the configuration ID of the configuration that was used to create the forked iModel in the transform parameters. Then the source iModel of that configuration becomes the target, and the target iModel will have to be the source. So source project and iModel ids should point to the forked iModel and target project and iModel information should refer to the main iModel.

{
    "sourceProjectId": "00000000-0000-0000-0000-000000000000", // forked iModel's project id
    "sourceIModelId": "00000000-0000-0000-0000-000000000000",  // forked iModel's id
    "targetProjectId": "00000000-0000-0000-0000-000000000000", // main iModel's project id
    "targetIModelId": "00000000-0000-0000-0000-000000000000",  // main iModel's id
    "transformParameters": {
        "configurationId": "00000000-0000-0000-0000-000000000000" // configuration id of CreateFork configuration
    }

Explanation of specific properties configuration.

configurationId - required property that specifies configuration id, which was used to fork the main iModel.

If you want to transform new changes in the forked iModel after you merge it back into the main iModel, use the same configuration that was created by this endpoint.
Note: Creating a configuration does not run the transformation. To run the transformation, please see transformations reference.

Authentication

Requires Authorization header with valid Bearer token for scope transformations:modify.

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.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.