MergeIModel - Transformations

Transformations

Download API definition:

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

post https://dev-api.bentley.com/transformations/configurations/mergeimodel

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.

Limitations:

Forking and merging workflows do not support modifying the same entity in multiple iModels. There is no provided functionality to see conflicting changes or to resolve them, so the transformation will use "last synchronization wins" strategy automatically. As a result, only the most recent synchronized changes made to an element will be retained, overwriting updates from earlier forks. E.g. in scenario where same element is modified in two forks, and then those both forks are merged into main iModel, changes in last synchronized fork will override previously synchronized changes.

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 and targetIModelId is main iModel, it means that iModel fork is being merged to main iModel.
If sourceIModelId is main iModel and targetIModelId 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 and BisCore: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.

Request

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Request body

Create MergeIModel configuration

comment

String

Yes

Comment for the changeset created after transformation.

transformName

String

Yes

User friendly name of the transformation.

sourceIModelId

String

Yes

ID of the source iModel.

targetIModelId

String

Yes

ID of the target iModel.

sourceProjectId

String

Yes

ProjectId of the source iModel.

targetProjectId

String

Yes

ProjectId of the target iModel.

Example

json

{
    "transformName": "Example name",
    "sourceProjectId": "00000000-0000-0000-0000-000000000000",
    "sourceIModelId": "00000000-0000-0000-0000-000000000000",
    "targetProjectId": "00000000-0000-0000-0000-000000000000",
    "targetIModelId": "00000000-0000-0000-0000-000000000000",
    "comment": "Example comment"
}

Response

Response 201 Created

Returns the created configuration.

json

{
    "configuration": {
        "id": "00000000-0000-0000-0000-000000000000",
        "transformName": "Transformation name",
        "comment": "comment",
        "createdDateTime": "2021-08-02T14:51:33.6133333+00:00",
        "modifiedDateTime": "2021-08-02T14:52:33.6133333+00:00",
        "transformType": "MergeIModel",
        "_links": {
            "sourceIModel": {
                "href": "https://api.bentley.com/imodels/00000000-0000-0000-0000-000000000000"
            },
            "targetIModel": {
                "href": "https://api.bentley.com/imodels/00000000-0000-0000-0000-000000000000"
            },
            "sourceProject": {
                "href": "https://api.bentley.com/itwins/00000000-0000-0000-0000-000000000000"
            },
            "targetProject": {
                "href": "https://api.bentley.com/itwins/00000000-0000-0000-0000-000000000000"
            }
        }
    }
}

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

{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 403 Forbidden

User has insufficient permissions.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

Response 404 Not Found

This response indicates that the provided Project or iModel could not be found.

json

{
    "error": {
        "code": "IModelNotFound",
        "message": "Requested IModel is not available."
    }
}

Response 422 Unprocessable Entity

Given data is invalid.

json

{
    "error": {
        "code": "MissingRequestBody",
        "message": "Request body was not provided."
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json

{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

retry-after

Number of seconds to wait until client is allowed to make more requests.

Definitions

Link

href

String

Link to a resource.

json

{
    "type": "object",
    "title": "Link",
    "properties": {
        "href": {
            "type": "string",
            "description": "Link to a resource."
        }
    },
    "additionalProperties": false
}

Error

Contains error information.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "target": {
            "type": "string",
            "nullable": true,
            "description": "The target of the error."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information.",
    "additionalProperties": true
}

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.

error

Error

Error information.

json

{
    "type": "object",
    "title": "Error Response",
    "required": [
        "error"
    ],
    "properties": {
        "error": {
            "$ref": "#/components/schemas/Error",
            "description": "Error information."
        }
    },
    "description": "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.",
    "additionalProperties": false
}

Links

sourceIModel

targetIModel

sourceProject

targetProject

json

{
    "type": "object",
    "title": "Links",
    "properties": {
        "sourceIModel": {
            "$ref": "#/components/schemas/Link"
        },
        "targetIModel": {
            "$ref": "#/components/schemas/Link"
        },
        "sourceProject": {
            "$ref": "#/components/schemas/Link"
        },
        "targetProject": {
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

Merge iModel configuration properties

String

ID of the configuration.

_links

Links_ConfigurationData

comment

String, null

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

transformType

String

Type of the transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

json

{
    "type": "object",
    "title": "Merge iModel configuration properties",
    "required": [
        "id",
        "transformName",
        "comment",
        "createdDateTime",
        "modifiedDateTime",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "comment": {
            "type": "string",
            "example": "Example comment",
            "nullable": true,
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "transformType": {
            "type": "string",
            "example": "FilterIModel",
            "description": "Type of the transformation."
        },
        "createdDateTime": {
            "type": "string",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.0000000Z",
            "description": "Time the configuration was created at."
        },
        "modifiedDateTime": {
            "type": "string",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.0000000Z",
            "description": "Time the configuration was last modified at."
        }
    },
    "additionalProperties": false
}

Create MergeIModel configuration

Data needed to create MergeIModel configuration.

comment

String

Comment for the changeset created after transformation.

transformName

String

User friendly name of the transformation.

sourceIModelId

String

ID of the source iModel.

targetIModelId

String

ID of the target iModel.

sourceProjectId

String

ProjectId of the source iModel.

targetProjectId

String

ProjectId of the target iModel.

json

{
    "type": "object",
    "title": "Create MergeIModel configuration",
    "required": [
        "comment",
        "sourceProjectId",
        "sourceIModelId",
        "targetProjectId",
        "targetIModelId",
        "transformName"
    ],
    "properties": {
        "comment": {
            "type": "string",
            "example": "Example comment",
            "description": "Comment for the changeset created after transformation."
        },
        "transformName": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "sourceIModelId": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the source iModel."
        },
        "targetIModelId": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the target iModel."
        },
        "sourceProjectId": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ProjectId of the source iModel."
        },
        "targetProjectId": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ProjectId of the target iModel."
        }
    },
    "description": "Data needed to create MergeIModel configuration.",
    "additionalProperties": false
}

Merge iModel configuration

configuration

Configuration_MergeIModel

json

{
    "type": "object",
    "title": "Merge iModel configuration",
    "required": [
        "configuration"
    ],
    "properties": {
        "configuration": {
            "$ref": "#/components/schemas/Configuration_MergeIModel"
        }
    },
    "additionalProperties": false
}

Was this page helpful?