Create Transformation - Transformations

REST API Overview

Reference

Transformations

Download API definition:

POST https://api.bentley.com/transformations/

This endpoint is used to run the transformation based on an already created configuration. Sending a post request will submit a background processing job that is able to report progress back to the same transformation instance that you can query by the transformation ID.

First run of the transformation will process the whole source iModel and push data to the target iModel. Only one transformation job can run on the same target iModel at the same time. Consecutively submitted jobs for the same configurationId will only process changes to the source iModel.

Transformation status

Transformation status parameter provides information about the current status of a transformation. The status can have one of the following values:

Created - this status is assigned when the transformation is created, but background job has not started yet. Once the background job is started, initialization begins.
Initializing - a transformation in the Initializing status means that the background job has been started and is preparing to run the transformation. This process involves downloading all the necessary iModels and setting up other parameters as required by the transformation.
Started - when the transformation background job starts processing the iModel elements based on the transformation configuration, the status changes to Started. You can monitor the progress of the transformation during this stage by tracking the count of processed elements. This count allows you to estimate when the transformation might finish.
Succeeded - upon successful completion of the transformation, the status is set to Succeeded. This means all iModel elements have been processed as per the transformation configuration without any errors.
Failed - if an error occurs during the transformation process (while in the Initializing or Started statuses), the status changes to Failed. This indicates that the transformation has ended prematurely and would leave the target iModel in an invalid state if any intermediate changes were pushed. If the transformation is in an invalid state, it is necessary to use a new target iModel in order to proceed with further transformations.
Aborted - a transformation is labeled as Aborted when it is manually cancelled by the user. Note that a transformation cannot be cancelled if it has already finished (its status is either Failed or Succeeded).

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.

Rate limits

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

Transformation Element Limiting

When you run a transformation with the "Try it out" function, you are limited to transforming iModels with up to 1000 entities, which includes elements and relationships. For more information about entities, see Element Fundamentals and Relationship Fundamentals. If an iModel has more than 1000 entities, transformation will not succeed. To transform iModels without any limits, please generate authorization for a different client and call this endpoint directly or add the newly generated authorization value to a Authorization field. For more information about using your own client, see Authorize Service.

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

Transformation (Create)

configurationId

String

Yes

configurationId of this transformation.

sourceChangeSetId

String

Optional ID of the change set used for source iModel when running transformation.

Example

json

{
    "configurationId": "00000000-0000-0000-0000-000000000000",
    "sourceChangeSetId": "0"
}

Response

Response 201 Created

Returns the created transformation.

json

{
    "transformation": {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "Created",
        "errorMessage": "",
        "processedElementCount": 0,
        "totalElementCount": 100,
        "createdDateTime": "2024-03-05T14:51:33.6133333Z",
        "startedDateTime": "2021-08-02T14:51:33.6133333Z",
        "finishedDateTime": "2021-08-02T14:51:33.6133333Z",
        "sourceChangeSetId": "0",
        "_links": {
            "configuration": {
                "href": "https://api.bentley.com/transformations/configurations/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

If user has insufficient permissions.

json

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

Response 404 Not Found

Configuration specified in configurationId is not available.

json

{
    "error": {
        "code": "ConfigurationNotFound",
        "message": "Requested Configuration is not available."
    }
}

Response 422 Unprocessable Entity

If there is an ongoing transformation with target iModel or configuration does not exist or transformation could not be started.

json

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

Response 429 Too many requests

This response indicates that the user has sent too many requests in a given amount of time.

json

{
    "error": {
        "code": "TooManyRequests",
        "message": "More requests were received than the subscription rate-limit allows."
    }
}

Response headers

retry-after

The number of requests exceeds the rate-limit for the client subscription.

Definitions

Transformation status

TableSchema

No data.

Transformation

TableSchema

transformation

Transformation

Transformation (Create)

TableSchema

configurationId

String

configurationId of this transformation.

sourceChangeSetId

String

Optional ID of the change set used for source iModel when running transformation.

Transformation

Transformation data.

TableSchema

String

ID of the transformation.

status

TransformationStatus

Available values: Created, Initializing, Started, Succeeded, Failed, Aborted.

errorMessage

String

Error message that gets filled if an error occurred during transformation.

processedElementCount

Int32

Number of elements that have been processed.

totalElementCount

Int32

Total amount of elements to process.

createdDateTime

Date-time

Time the transformation entity was created.

startedDateTime

Date-time

Time the transformation was initiated.

finishedDateTime

Date-time

Time the transformation was finished.
Empty if transformation is still running.

sourceChangeSetId

String,null

ID of the last change set used for source iModel.

lastTargetChangesetPushed

String,null

ID of last changeset pushed to target iModel.

_links

Links_TransformationData

Link to related configuration.

Links

TableSchema

configuration

Link

Link to configuration.

Link

TableSchema

href

String

Link to a resource.

DetailedError

Contains error information and an array of more specific errors.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

The target of the error.

details

Error[]

Optional array of more specific errors.

Detailed 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.

TableSchema

error

DetailedError

Error Detailed information.

Error

Contains error information.

TableSchema

code

String

One of a server-defined set of error codes.

message

String

A human-readable representation of the error.

target

String

The target of the error.

Error Response

TableSchema

error

Error

Error information.