Import iModel - Transformations

Transformations

Download API definition:

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

post https://qa-api.bentley.com/transformations/configurations/import-imodel

This endpoint is used to create a configuration for an Import IModel transformation.

Import iModel transformation imports data from source iModel to the specified target iModel. This data can either be the whole iModel, or data that is associated to a RepositoryLink element.

During the transformation a BisCore:Subject element is created. The subject's CodeValue is set to the source iModel's id and the UserLabel is set to the source iModel's name. All data from the source iModel is imported under the newly created subject. Because of this, multiple iModels can be imported into the same target iModel effectively combining them while avoiding most of the conflicts between the sources.

Element Conflicts

Element conflicts may occur during the iModel import process in two scenarios:

Conflicting Codes - When elements in the source and target iModels share the same code.
Conflicting Federation GUIDs - When elements in both iModels have identical federation guids.

Resolution Behavior:
When conflicts occur, elements from the source iModel being imported will overwrite the corresponding elements in the target iModel. This may result in the conflicting elements appearing under a different source subject that was created by another Import iModel transformation.

Additionally, even if an element itself does not conflict, but its model does conflict, the element will still be inserted into that model. This means the element may appear under a different source subject than expected if the model was already imported by another Import iModel transformation.

Importing the whole iModel

To import the entire source iModel into the target omit the transformParameters property from your request body.

Importing data associated to a `RepositoryLink` element

To import only the data that is associated to a RepositoryLink add the repository link's federation guid to the transformParameters.fedGuidsOfRepositoriesToExport array in the request body.
A RepositoryLink element represents a link to an external repository (e.g. a design file).
A federation guid identifies a real-world entity that the element represents and "federates" the element to its external meaning. It is used as a stable identifier that external systems can utilize to reference the element. More about federation guids here.

Transformations service relies on the correct provenance structure in the source iModel in order to process it correctly.

ExternalSourceAspects must reference ExternalSource elements by their Source navigation properties.
ExternalSource elements must reference their RepositoryLink elements by their Repository navigation properties.

Any elements that do not have an ExternalSourceAspect related to a RepositoryLink are considered "shared" between all repositories and are always imported. More information about provenance in bis can be found here.

Configuration specific properties explained:

fedGuidsOfRepositoriesToExport - federation guids of RepositoryLink elements.

Limitations:

Only one repository link's federation guid per configuration is supported at this time.
This API does not support combining iModels that have conflicting dynamic ECSchemas. Conflicting ECSchemas are two ECSchemas that have the same name, but have at least one difference such as: different aliases or any difference between EC object items (EC schema contents). For example, "CustomSchema" in iModel "A" has an ECClass "MyClass", while "CustomSchema" in iModel "B" doesn't have an ECClass "MyClass". In case of ECSchema conflict, transformation will fail with an error message. Those error messages might vary depending on the conflict that was encountered. Transformation status and it's error message can be retrieved by sending GET transformation request.

In addition to exported data, the transformer will also push some additional metadata. 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.
Element provenance information (BisCore:ExternalSourceAspects) for elements that do not have federation guids.

Transformations service creates an Editing Channel with key IModelTransformations. All source iModel data is exported under a channel root subject named IModelTransformationsChannel. Read more about Editing Channels here.

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 itwin-platform.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

You must have imodels_write assigned for the target iModel and imodels_read assigned for the source iModel within related configuration. You can check iModel permissions here.

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.v2+json is recommended.

Request body

Create ImportIModel configuration

name

String

Yes

User friendly name of the transformation.

sourceIModelId

String

Yes

ID of the source iModel.

targetIModelId

String

Yes

ID of the target iModel.

transformParameters

TParams_ImportIModel

changesetDescription

String

Yes

Description for the changeset created after transformation.

Example

json

{
    "name": "Example name",
    "sourceIModelId": "00000000-0000-0000-0000-000000000000",
    "targetIModelId": "00000000-0000-0000-0000-000000000000",
    "changesetDescription": "Example description"
}

Response

Response 201 Created

Returns the created configuration.

json

{
    "configuration": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "Transformation name",
        "changesetDescription": "Example description",
        "createdDateTime": "2021-08-02T02:51:33.0000000+00:00",
        "modifiedDateTime": "2021-08-02T02:52:33.0000000+00:00",
        "transformType": "ImportIModel",
        "transformParameters": {
            "fedGuidsOfRepositoriesToExport": ["00000000-0000-0000-0000-000000000000"]
        },
        "_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"
            }
        }
    }
}

Response 400 Bad Request

The request cannot be processed by the server due to a client error (e.g. malformed request syntax)

json

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

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 is not authorized to create a configuration.

json

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

Response 422 Unprocessable Entity

The referenced iModel does not exist.

json

{
    "error": {
        "code": "InvalidTransformationsRequest",
        "message": "Cannot create Configuration.",
        "details": [{
            "code": "InvalidRequestBody",
            "message": "User is missing permission 'Read' to iModel '00000000-0000-0000-0000-000000000000'.",
            "target": "SourceIModelId"
        }]
    }
}

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
}

DetailedError

Contains error information and an array of more specific errors.

code

String

One of a server-defined set of error codes.

target

String, null

The target of the error.

details

Error[]

Optional array of more specific errors.

message

String

A human-readable representation of the error.

json

{
    "type": "object",
    "required": [
        "code",
        "message",
        "details"
    ],
    "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."
        },
        "details": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Error"
            },
            "description": "Optional array of more specific errors."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        }
    },
    "description": "Contains error information and an array of more specific errors.",
    "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
}

ImportIModel configuration properties

fedGuidsOfRepositoriesToExport

String[]

json

{
    "type": "object",
    "title": "ImportIModel configuration properties",
    "properties": {
        "fedGuidsOfRepositoriesToExport": {
            "type": "array",
            "items": {
                "type": "string"
            },
            "maxItems": 1
        }
    },
    "additionalProperties": false
}

Detailed Error Response

error

DetailedError

Error Detailed information.

json

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

Link

targetIModel

Link

json

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

Import iModel configuration properties transformType

Type of the transformation.

ImportIModel

String

json

{
    "enum": [
        "ImportIModel"
    ],
    "type": "string",
    "description": "Type of the transformation.",
    "title": "Import iModel configuration properties transformType"
}

Import iModel configuration properties

String

ID of the configuration.

name

String

User friendly name of the transformation.

_links

Links_ConfigurationData

Import iModel configuration properties transformType

Configuration_ImportIModel-transformType

Type of the transformation.

createdDateTime

Date-time

Time the configuration was created at.

modifiedDateTime

Date-time

Time the configuration was last modified at.

transformParameters

TParams_ImportIModel

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Import iModel configuration properties",
    "required": [
        "id",
        "name",
        "changesetDescription",
        "createdDateTime",
        "modifiedDateTime",
        "transformType",
        "_links"
    ],
    "properties": {
        "id": {
            "type": "string",
            "example": "00000000-0000-0000-0000-000000000000",
            "description": "ID of the configuration."
        },
        "name": {
            "type": "string",
            "example": "Example name",
            "description": "User friendly name of the transformation."
        },
        "_links": {
            "$ref": "#/components/schemas/Links_ConfigurationData"
        },
        "transformType": {
            "enum": [
                "ImportIModel"
            ],
            "type": "string",
            "description": "Type of the transformation.",
            "title": "Import iModel configuration properties transformType",
            "$ref": "#/components/schemas/Configuration_ImportIModel-transformType"
        },
        "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."
        },
        "transformParameters": {
            "$ref": "#/components/schemas/TParams_ImportIModel"
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "additionalProperties": false
}

Create ImportIModel configuration

Data needed to create ImportIModel configuration.

name

String

User friendly name of the transformation.

sourceIModelId

String

ID of the source iModel.

targetIModelId

String

ID of the target iModel.

transformParameters

TParams_ImportIModel

changesetDescription

String

Description for the changeset created after transformation.

json

{
    "type": "object",
    "title": "Create ImportIModel configuration",
    "required": [
        "changesetDescription",
        "sourceIModelId",
        "targetIModelId",
        "name"
    ],
    "properties": {
        "name": {
            "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."
        },
        "transformParameters": {
            "$ref": "#/components/schemas/TParams_ImportIModel"
        },
        "changesetDescription": {
            "type": "string",
            "example": "Example comment",
            "description": "Description for the changeset created after transformation."
        }
    },
    "description": "Data needed to create ImportIModel configuration.",
    "additionalProperties": false
}

Import iModel configuration

configuration

Configuration_ImportIModel

json

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

Was this page helpful?