Delete Transformation - Transformations

Transformations

Download API definition:

DELETE https://dev-api.bentley.com/transformations/{transformationId}

This endpoint is used to delete an ongoing transformation for a provided transformationId.

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.

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.

Request

Request parameters

transformationId

Yes

ID of the transformation

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response

Response 200 OK

Returns deleted transformation with the given ID.

json

{
    "transformation": {
        "id": "00000000-0000-0000-0000-000000000000",
        "status": "Aborted",
        "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"
            }
        }
    }
}

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 has insufficient permissions.

json

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

Response 404 Not Found

Transformation with the given ID does not exist.

json

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

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

Transformation status

Created

String

Started

String

Succeeded

String

Failed

String

Aborted

String

Initializing

String

json

{
    "enum": [
        "Created",
        "Started",
        "Succeeded",
        "Failed",
        "Aborted",
        "Initializing"
    ],
    "type": "string",
    "title": "Transformation status"
}

Transformation

transformation

Transformation

json

{
    "type": "object",
    "title": "Transformation",
    "properties": {
        "transformation": {
            "$ref": "#/components/schemas/Transformation"
        }
    },
    "additionalProperties": false
}

Transformation

Transformation data.

String

ID of the transformation.

status

TransformationStatus

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

errorCode

Int32

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

errorMessage

String, null

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, null

Time the transformation was initiated.

finishedDateTime

Date-time, null

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.

json

{
    "type": "object",
    "title": "Transformation",
    "description": "Transformation data.",
    "properties": {
        "id": {
            "type": "string",
            "description": "ID of the transformation.",
            "example": "00000000-0000-0000-0000-000000000000"
        },
        "status": {
            "description": "Available values: `Created`, `Initializing`, `Started`, `Succeeded`, `Failed`, `Aborted`.",
            "$ref": "#/components/schemas/TransformationStatus"
        },
        "errorCode": {
            "type": "integer",
            "description": "Error code that gets filled if an error occurred during transformation.",
            "nullable": false,
            "format": "int32",
            "example": 4006
        },
        "errorMessage": {
            "type": "string",
            "description": "Error message that gets filled if an error occurred during transformation.",
            "nullable": true,
            "example": "Example message"
        },
        "processedElementCount": {
            "type": "integer",
            "description": "Number of elements that have been processed.",
            "format": "int32",
            "example": 50
        },
        "totalElementCount": {
            "type": "integer",
            "description": "Total amount of elements to process.",
            "format": "int32",
            "example": 100
        },
        "createdDateTime": {
            "type": "string",
            "description": "Time the transformation entity was created.",
            "format": "date-time",
            "example": "0000-00-00T00:00:00.0000000Z"
        },
        "startedDateTime": {
            "type": "string",
            "description": "Time the transformation was initiated.",
            "format": "date-time",
            "nullable": true,
            "example": "0000-00-00T00:00:00.0000000Z"
        },
        "finishedDateTime": {
            "type": "string",
            "description": "Time the transformation was finished.\r\nEmpty if transformation is still running.",
            "format": "date-time",
            "nullable": true,
            "example": "0000-00-00T00:00:00.0000000Z"
        },
        "sourceChangeSetId": {
            "type": "string",
            "nullable": true,
            "description": "ID of the last change set used for source iModel.",
            "example": "0"
        },
        "lastTargetChangesetPushed": {
            "type": "string",
            "nullable": true,
            "description": "ID of last changeset pushed to target iModel.",
            "example": "0"
        },
        "_links": {
            "description": "Link to related configuration.",
            "$ref": "#/components/schemas/Links_TransformationData"
        }
    },
    "required": [
        "id",
        "status",
        "errorMessage",
        "processedElementCount",
        "totalElementCount",
        "createdDateTime",
        "_links"
    ],
    "additionalProperties": false
}

Links

configuration

Link

Link to configuration.

json

{
    "type": "object",
    "title": "Links",
    "properties": {
        "configuration": {
            "description": "Link to configuration.",
            "$ref": "#/components/schemas/Link"
        }
    },
    "additionalProperties": false
}

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.

message

String

A human-readable representation of the error.

target

String, null

The target of the error.

json

{
    "type": "object",
    "description": "Contains error information.",
    "properties": {
        "code": {
            "type": "string",
            "description": "One of a server-defined set of error codes."
        },
        "message": {
            "type": "string",
            "description": "A human-readable representation of the error."
        },
        "target": {
            "type": "string",
            "description": "The target of the error.",
            "nullable": true
        }
    },
    "required": [
        "code",
        "message"
    ],
    "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",
    "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.",
    "properties": {
        "error": {
            "description": "Error information.",
            "$ref": "#/components/schemas/Error"
        }
    },
    "required": [
        "error"
    ],
    "additionalProperties": false
}

Was this page helpful?