Get Animation 3D Transform - Schedules

Schedules

Download API definition:

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

Get Animation 3D Transform

GET https://dev-api.bentley.com/schedules/{scheduleId}/animation-3d-transforms/{animation3dTransformId}

Gets the details of an Animation 3D Transform.

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.

Rate limits

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

Request parameters

scheduleId

Yes

The unique identifier of the Schedule.

animation3dTransformId

Yes

The unique identifier of the Animation 3D Transform.

Request headers

If-None-Match

A header that makes the request conditional. If the ETag of the requested resource or resource collection matches the provided value, a 304 (Not Modified) response is returned. For more information see the official documentation.

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

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

Response 200 OK

json

{
    "animation3dTransform": {
        "id": "050d2013-0577-42c9-8658-6da1c6d3e556",
        "transform": [
            1,
            0,
            0,
            37.453269958496094,
            0,
            1,
            0,
            -63.49726867675781,
            0,
            0,
            1,
            0,
            0,
            0,
            0,
            1
        ]
    }
}

Response headers

ETag

A header that identifies a specific version of a resource or resource collection. For more information see the official documentation.

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

This response indicates that the provided Animation 3D Transform or Schedule is not available.

json

{
    "error": {
        "code": "Animation3dTransformNotFound",
        "message": "Requested Animation 3D Transform is not available.",
        "target": "animation3dTransformId"
    }
}

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

Animation 3D Transform

Representation of an Animation 3D Transform.

String

The unique identifier of the Animation 3D Transform.

transform

TransformMatrix4

The 4x4 spacial transformation matrix. This matrix is in row-major order.

json

{
    "title": "Animation 3D Transform",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Animation 3D Transform."
        },
        "transform": {
            "$ref": "#/components/schemas/TransformMatrix4",
            "description": "The 4x4 spacial transformation matrix. This matrix is in row-major order."
        }
    },
    "additionalProperties": false,
    "description": "Representation of an Animation 3D Transform."
}

Animation 3D Transform Response

Container for Animation 3D Transform object.

animation3dTransform

Animation3dTransform

Animation 3D Transform properties.

json

{
    "title": "Animation 3D Transform Response",
    "type": "object",
    "properties": {
        "animation3dTransform": {
            "$ref": "#/components/schemas/Animation3dTransform",
            "description": "Animation 3D Transform properties."
        }
    },
    "additionalProperties": false,
    "description": "Container for Animation 3D Transform object."
}

Transform Matrix 4

Represents a transformation in 3D space as a 4x4 matrix. Here the upper left 3x3 submatrix is responsible for linear transformation such as scaling rotation and shear. The upper-right 1x3 submatrix represents translation. The bottom row should always contain values 0 0 0 1. This matrix is in row-major order.

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?

Authentication

Rate limits

Request

Request parameters

Request headers

Response

Response 200 OK

Response headers

Response 304 Not Modified

Response 401 Unauthorized

Response 404 Not Found

Response 429 Too many requests

Response headers

Definitions

Animation 3D Transform

Animation 3D Transform Response

Transform Matrix 4

Error

Error Response