This endpoint is used to track progress of a transformation for a provided transformationId.

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

Transformation error code

---

Transformation errorCode parameter provides information about error which occurred during transformation.

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_read 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": {
        "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",
        "lastTargetChangesetPushed": "0",
        "_links": {
            "configuration": {
                "href": "https://api.bentley.com/transformations/configurations/00000000-0000-0000-0000-000000000000"
            }
        }
    }
}

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

{
    "error": {
        "code": "TransformationNotFound",
        "message": "Requested Transformation is not available."
    }
}

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