Get Report - Transformations

Transformations

Download API definition:

Get Report

This operation is a Technical Preview and is available for testing purposes only. Do not use in production.

GET https://dev-api.bentley.com/transformations/reports?transformationId={transformationId}

This endpoint is used to retrieve the download URL for a transformation report with a provided transformation ID.

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_read assigned at the target 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

Transformation ID

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 transformation report with the given transformation ID.

json

{
    "reports": [{
        "id": "4WVKWXTNlEevnPTTg3M381C93mAZEGZDK88I3YJMAJk",
        "transformationId": "00000000-0000-0000-0000-000000000000",
        "configurationId": "00000000-0000-0000-0000-000000000000",
        "targetIModelId": "00000000-0000-0000-0000-000000000000",
        "_links": {
            "download": {
                "href": "https://example.com/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000?sv=2019-07-07&sr=b&sig=**removed**&st=2021-07-30T10%3A53%3A09.5224547Z&se=2021-07-30T11%3A13%3A09.5224552Z&sp=r"
            }
        }
    }]
}

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 404 Not Found

Transformation Report with the given transformation ID does not exist.

json

{
    "error": {
        "code": "ReportNotFound",
        "message": "Requested Report is not available."
    }
}

Response 422 Unprocessable Entity

Invalid request to get report.

json

{
    "error": {
        "code": "InvalidTransformationsRequest",
        "message": "Cannot get Report.",
        "details": [{
            "code": "InvalidValue",
            "message": "'{passedValue}' is not a valid {queryParam}.",
            "target": "{queryParam}"
        }]
    }
}

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

Reports Collection

Transformation report.

reports

Object[]

Transformation report.

json

{
    "type": "object",
    "title": "Reports Collection",
    "description": "Transformation report.",
    "properties": {
        "reports": {
            "type": "array",
            "description": "Transformation report.",
            "items": {
                "type": "object",
                "properties": {
                    "id": {
                        "type": "string",
                        "description": "ID of the report.",
                        "example": "4WWKWXTNlEevnPTTg3M381VfJ0RKY1xKypYI3XHoIj4"
                    },
                    "transformationId": {
                        "type": "string",
                        "description": "ID of the transformation.",
                        "example": "00000000-0000-0000-0000-000000000000"
                    },
                    "configurationId": {
                        "type": "string",
                        "description": "ID of the configuration.",
                        "example": "00000000-0000-0000-0000-000000000000"
                    },
                    "targetIModelId": {
                        "type": "string",
                        "description": "ID of the target iModel.",
                        "example": "00000000-0000-0000-0000-000000000000"
                    },
                    "_links": {
                        "type": "object",
                        "properties": {
                            "download": {
                                "$ref": "#/components/schemas/Link"
                            }
                        },
                        "required": [
                            "download"
                        ],
                        "additionalProperties": false
                    }
                },
                "required": [
                    "id",
                    "transformationId",
                    "configurationId",
                    "targetIModelId",
                    "_links"
                ],
                "additionalProperties": false
            }
        }
    },
    "additionalProperties": false
}

DetailedError

Contains error information and an array of more specific errors.

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.

details

Error[]

Optional array of more specific errors.

json

{
    "type": "object",
    "description": "Contains error information and an array of more specific errors.",
    "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
        },
        "details": {
            "type": "array",
            "description": "Optional array of more specific errors.",
            "items": {
                "$ref": "#/components/schemas/Error"
            }
        }
    },
    "required": [
        "code",
        "message",
        "details"
    ],
    "additionalProperties": true
}

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.

error

DetailedError

Error Detailed information.

json

{
    "type": "object",
    "title": "Detailed 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 Detailed information.",
            "$ref": "#/components/schemas/DetailedError"
        }
    },
    "required": [
        "error"
    ],
    "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

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?