Get Started
Documentation
Samples
Table of contents
Overview
Tutorials
Samples
Changelog
Transformations

Transformations

Download API definition:
Get Transformation
GET https://api.bentley.com/transformations/{transformationId}

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

Authentication

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

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

Rate limits

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

Request

Request parameters

Name
In
Required?
Description
transformationId
template
Yes

ID of the transformation

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with scope transformations:read

Accept
No

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

Response

Response 200 OK

Returns transformation with the given ID.

json
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
Response 404 Not Found
Transformation with the given ID does not exist.
json
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
json
Response headers
Name
Description
retry-after
The number of requests exceeds the rate-limit for the client subscription.
Definitions
Transformation status
TableSchema
Name
Type
Description
No data.
Transformation
TableSchema
Name
Type
Description
transformation
Transformation
Transformation
Transformation data.
TableSchema
Name
Type
Description
id
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.
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
Name
Type
Description
configuration
Link
Link to configuration.
Link
TableSchema
Name
Type
Description
href
String
Link to a resource.
Error
Contains error information and an optional array of more specific errors.
TableSchema
Name
Type
Description
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
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
Name
Type
Description
error
Error
Error information.