Get Animation Statistics - Schedules

Schedules

Download API definition:

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

GET https://dev-api.bentley.com/schedules/{scheduleId}/animation-statistics

Gets the Animation Statistics of a Schedule.

Animation Statistics

Animation information can take a long time to load. Animation Statistics may be used to render loading bars for the animation download process.

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.

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

{
    "animationStatistics": {
        "animation3dPathAssignmentCount": 122,
        "animation3dPathCount": 122,
        "animation3dPathKeyframeCount": 140,
        "animation3dTransformCount": 0,
        "animationBindingCount": 30024,
        "appearanceProfileCount": 44,
        "taskCount": 1068
    }
}

Response headers

Continuation-Token

A token used for pagination to retrieve the next set of results. It indicates where the previous page of results ended, allowing you to fetch the subsequent batch of data.

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 Schedule is not available.

json

{
    "error": {
        "code": "ScheduleNotFound",
        "message": "Requested Schedule is not available.",
        "target": "scheduleId"
    }
}

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 Statistics

Statistics of Schedule animation.

animation3dPathAssignmentCount

Integer

The number of Animation 3D Path Assignments in the Schedule.

animation3dPathCount

Integer

The number of Animation 3D Paths in the Schedule.

animation3dPathKeyframeCount

Integer

The number of Animation 3D Path Keyframes in the Schedule.

animation3dTransformCount

Integer

The number of Animation 3D Transforms in the Schedule.

animationBindingCount

Integer

The number of Animation Bindings in the Schedule.

appearanceProfileCount

Integer

The number of Appearance Profiles in the Schedule.

taskCount

Integer

The number of Tasks in the Schedule.

json

{
    "title": "Animation Statistics",
    "type": "object",
    "properties": {
        "animation3dPathAssignmentCount": {
            "type": "integer",
            "description": "The number of Animation 3D Path Assignments in the Schedule."
        },
        "animation3dPathCount": {
            "type": "integer",
            "description": "The number of Animation 3D Paths in the Schedule."
        },
        "animation3dPathKeyframeCount": {
            "type": "integer",
            "description": "The number of Animation 3D Path Keyframes in the Schedule."
        },
        "animation3dTransformCount": {
            "type": "integer",
            "description": "The number of Animation 3D Transforms in the Schedule."
        },
        "animationBindingCount": {
            "type": "integer",
            "description": "The number of Animation Bindings in the Schedule."
        },
        "appearanceProfileCount": {
            "type": "integer",
            "description": "The number of Appearance Profiles in the Schedule."
        },
        "taskCount": {
            "type": "integer",
            "description": "The number of Tasks in the Schedule."
        }
    },
    "additionalProperties": false,
    "description": "Statistics of Schedule animation."
}

Animation Statistics Response

Container for Animation Statistics object.

animationStatistics

AnimationStatistics

Animation Statistics.

json

{
    "title": "Animation Statistics Response",
    "type": "object",
    "properties": {
        "animationStatistics": {
            "$ref": "#/components/schemas/AnimationStatistics",
            "description": "Animation Statistics."
        }
    },
    "additionalProperties": false,
    "description": "Container for Animation Statistics object."
}

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?

Animation Statistics

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 Statistics

Animation Statistics Response

Error

Error Response