Get Animation 3D Path Assignments - 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 Path Assignments

GET https://dev-api.bentley.com/schedules/{scheduleId}/animation-3d-path-assignments[?$top][&$continuationToken]

Gets all Animation 3D Path Assignments of a Schedule.

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.

Animation 3D Path Assignment Alignment

Animation 3D Path Assignment Alignment describes the position of the assigned object relative to the Animation 3D Path.

Center: The center point of the object is aligned to the Animation 3D Path.
Custom: The alignment is defined manually by setting the X Y and Z properties.
Original: The object starts from it's original position.
MinX: The right side of the object's bounding box is aligned with the Animation 3D Path.
MaxX: The left side of the object's bounding box is aligned with the Animation 3D Path.
MinY: The back of the object's bounding box is aligned with the Animation 3D Path.
MaxY: The front of the object's bounding box is aligned with the Animation 3D Path.
MinZ: The top of the object's bounding box is aligned with the Animation 3D Path.
MaxZ: The bottom of the object's bounding box is aligned with the Animation 3D Path.

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.

$top

The $top system query option requests the number of items in the queried collection to be included in the result. When $top parameter is not provided default is set to 100. $top value cannot exceed 10000.

$continuationToken

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.

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

{
    "animation3dPathAssignments": [{
            "adjustForTaskPercentComplete": false,
            "alignment": "MinZ",
            "center": {
                "x": 0,
                "y": 0,
                "z": 0
            },
            "id": "8cc4bf37-20a4-41db-8111-322ed94cc4be",
            "motionEnd": 1,
            "motionStart": 0,
            "pathId": "263fbc39-5936-4dce-be8a-8149c6137c74",
            "pauseDuringNonWorkingTime": false,
            "reverseDirection": true
        },
        {
            "adjustForTaskPercentComplete": false,
            "alignment": "Custom",
            "center": {
                "x": 1,
                "y": 2.5,
                "z": -5
            },
            "id": "95ab86fe-7150-4115-b4b0-b39f02755c65",
            "motionEnd": 0.9,
            "motionStart": 0.1,
            "pathId": "bb0f45bf-8d1f-41bf-9935-b4ec0e870186",
            "pauseDuringNonWorkingTime": true,
            "reverseDirection": true
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/animation-3d-path-assignments?$top=2"
        },
        "next": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/animation-3d-path-assignments?$top=2&$continuationToken=eyJQcmltYXJ5U2tpcFRva2VuIjoiMDAwNGE5MDAtM2UxYy00NGNlLThhMzktYWUxZWRlY2M1MWY0IiwiU2Vjb25kYXJ5U2tpcFRva2VuIjpudWxsfQ=="
        }
    }
}

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 422 Unprocessable Entity

The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax).

json

{
    "error": {
        "code": "InvalidSchedulesRequest",
        "details": [{
                "code": "InvalidValue",
                "message": "Top value is not positive, or exceeds maximum page size.",
                "target": "$top"
            },
            {
                "code": "InvalidValue",
                "message": "Provided continuation token is invalid.",
                "target": "$continuationToken"
            }
        ],
        "message": "The request contains invalid properties."
    }
}

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 Path Assignment

Properties related to assignment of an Animation 3D Path.

adjustForTaskPercentComplete

Boolean

When this value is enabled the motion is affected by the Task percent complete.

alignment

Animation3dPathAssignmentAlignment

Value describing the alignment of the assigned objects to the path.

center

Point3

The offset of assigned object from the Animation 3D Path. The coordinate values are relative to the Animation 3D Path. Should only be used when alignment is set to Custom.

String

The unique identifier of the Animation 3D Path Assignment.

motionEnd

Double

Decimal value describing where on the 3D Path the object should start. This can be used if the object should only travel a portion of the distance. Value is in range [0, 1].

motionStart

Double

Decimal value describing where on the 3D Path the object should stop. This can be used if the object should only travel a portion of the distance. Value is in range [0, 1].

pathId

String

The unique identifier of the Animation 3D Path.

pauseDuringNonWorkingTime

Boolean

When this value is enabled the motion will be paused during non working hours.

reverseDirection

Boolean

Value specifying if the direction of the Animation 3d Path should be reversed.

json

{
    "title": "Animation 3D Path Assignment",
    "type": "object",
    "properties": {
        "adjustForTaskPercentComplete": {
            "type": "boolean",
            "description": "When this value is enabled the motion is affected by the Task percent complete."
        },
        "alignment": {
            "$ref": "#/components/schemas/Animation3dPathAssignmentAlignment",
            "description": "Value describing the alignment of the assigned objects to the path."
        },
        "center": {
            "$ref": "#/components/schemas/Point3",
            "description": "The offset of assigned object from the Animation 3D Path. The coordinate values are relative to the Animation 3D Path. Should only be used when alignment is set to Custom."
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Animation 3D Path Assignment."
        },
        "motionEnd": {
            "type": "number",
            "description": "Decimal value describing where on the 3D Path the object should start. This can be used if the object should only travel a portion of the distance. Value is in range [0, 1].",
            "format": "double"
        },
        "motionStart": {
            "type": "number",
            "description": "Decimal value describing where on the 3D Path the object should stop. This can be used if the object should only travel a portion of the distance. Value is in range [0, 1].",
            "format": "double"
        },
        "pathId": {
            "type": "string",
            "description": "The unique identifier of the Animation 3D Path."
        },
        "pauseDuringNonWorkingTime": {
            "type": "boolean",
            "description": "When this value is enabled the motion will be paused during non working hours."
        },
        "reverseDirection": {
            "type": "boolean",
            "description": "Value specifying if the direction of the Animation 3d Path should be reversed."
        }
    },
    "additionalProperties": false,
    "description": "Properties related to assignment of an Animation 3D Path."
}

Animation 3D Path Assignment Alignment

Animation 3D Path Assignment Alignment describes the position of the assigned object relative to the Animation 3D Path. See the Animation 3D Path Assignment Alignment section for details.

Unknown

String

Original

String

Center

String

Custom

String

MinX

String

MaxX

String

MinY

String

MaxY

String

MinZ

String

MaxZ

String

json

{
    "title": "Animation 3D Path Assignment Alignment",
    "enum": [
        "Unknown",
        "Original",
        "Center",
        "Custom",
        "MinX",
        "MaxX",
        "MinY",
        "MaxY",
        "MinZ",
        "MaxZ"
    ],
    "type": "string",
    "description": "Animation 3D Path Assignment Alignment describes the position of the assigned object relative to the Animation 3D Path. See the [Animation 3D Path Assignment Alignment](#animation-3d-path-assignment-alignment) section for details."
}

Animation 3D Path Assignments Response

List of Animation 3D Path Assignments.

animation3dPathAssignments

Animation3dPathAssignment[]

A list of Animation 3D Path Assignments.

_links

PagingLinks

Contains the hyperlinks to the current and next pages of results.

json

{
    "title": "Animation 3D Path Assignments Response",
    "type": "object",
    "properties": {
        "animation3dPathAssignments": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Animation3dPathAssignment"
            },
            "description": "A list of Animation 3D Path Assignments."
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "additionalProperties": false,
    "description": "List of Animation 3D Path Assignments."
}

Link

Hyperlink container.

href

String

Hyperlink to the specific entity.

json

{
    "type": "object",
    "properties": {
        "href": {
            "type": "string",
            "description": "Hyperlink to the specific entity."
        }
    },
    "additionalProperties": false,
    "description": "Hyperlink container."
}

Paging Links

URLs for redoing the current request and/or getting the next page of results if applicable.

self

Link

Relative URL for redoing the current request.

Link, null

Relative URL for getting the next page of results.

json

{
    "title": "Paging Links",
    "type": "object",
    "properties": {
        "self": {
            "$ref": "#/components/schemas/Link",
            "description": "Relative URL for redoing the current request."
        },
        "next": {
            "$ref": "#/components/schemas/Link",
            "description": "Relative URL for getting the next page of results.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "URLs for redoing the current request and/or getting the next page of results if applicable."
}

Point 3D

Double

The X coordinate.

Double

The Y coordinate.

Double

The Z coordinate.

json

{
    "title": "Point 3D",
    "type": "object",
    "properties": {
        "x": {
            "type": "number",
            "description": "The X coordinate.",
            "format": "double"
        },
        "y": {
            "type": "number",
            "description": "The Y coordinate.",
            "format": "double"
        },
        "z": {
            "type": "number",
            "description": "The Z coordinate.",
            "format": "double"
        }
    },
    "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?

Authentication

Animation 3D Path Assignment Alignment

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 422 Unprocessable Entity

Response 429 Too many requests

Response headers

Definitions

Animation 3D Path Assignment

Animation 3D Path Assignment Alignment

Animation 3D Path Assignments Response

Link

Paging Links

Point 3D

DetailedError

Detailed Error Response

Error

Error Response