This endpoint is used to track progress of a transformation for a provided transformationId.
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
Initializingstatus 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
Startedstatuses), 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
Abortedwhen it is manually cancelled by the user. Note that a transformation cannot be cancelled if it has already finished (its status is either
Authorization header with valid Bearer token for scope
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.
Returns transformation with the given ID.
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.
Transformation with the given ID does not exist.
Contains error information and an optional array of more specific errors.
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.