Get Operation - Schedules | iTwin Platform

Schedules

Download API definition:

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

Get Operation

GET https://dev-api.bentley.com/schedules/{scheduleId}/operations/{operationId}

Gets the details of an Operation.

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.

operationId

Yes

The unique identifier of the Operation.

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

{
    "operation": {
        "createdAt": "2019-11-15T12:00:00Z",
        "failureDescription": "An error occurred whilst processing your request.",
        "id": "bdc8fb5d-ce72-42f9-8818-bb2942927428",
        "percentComplete": 100,
        "status": "Failed",
        "subStatus": "Failed",
        "updatedAt": "2020-11-15T12:00:00Z"
    }
}

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

json

{
    "error": {
        "code": "OperationNotFound",
        "message": "Requested Operation is not available.",
        "target": "operationId"
    }
}

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

Operation

Contains information about a long-running operation.

createdAt

Date-time, null

Timestamp when the operation was requested.

failureDescription

String, null

Description for why the operation failed.

String

The unique identifier of the Operation.

percentComplete

Double

What percentage of the operation is completed.

status

OperationStatus

Current operation status.

subStatus

String, null

Current operation sub status.

updatedAt

Date-time

Timestamp when the operation reached the current status.

json

{
    "title": "Operation",
    "type": "object",
    "properties": {
        "createdAt": {
            "type": "string",
            "description": "Timestamp when the operation was requested.",
            "format": "date-time",
            "nullable": true
        },
        "failureDescription": {
            "type": "string",
            "description": "Description for why the operation failed.",
            "nullable": true
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Operation."
        },
        "percentComplete": {
            "type": "number",
            "description": "What percentage of the operation is completed.",
            "format": "double"
        },
        "status": {
            "$ref": "#/components/schemas/OperationStatus",
            "description": "Current operation status."
        },
        "subStatus": {
            "type": "string",
            "description": "Current operation sub status.",
            "nullable": true
        },
        "updatedAt": {
            "type": "string",
            "description": "Timestamp when the operation reached the current status.",
            "format": "date-time"
        }
    },
    "additionalProperties": false,
    "description": "Contains information about a long-running operation."
}

Operation Response

Response containing the requested Operation.

operation

Operation

Operation object.

json

{
    "title": "Operation Response",
    "type": "object",
    "properties": {
        "operation": {
            "$ref": "#/components/schemas/Operation",
            "description": "Operation object."
        }
    },
    "additionalProperties": false,
    "description": "Response containing the requested Operation."
}

Operation Status

Specifies the status of an operation.

Queued

String

Started

String

Failed

String

Succeeded

String

Unknown

String

json

{
    "title": "Operation Status",
    "enum": [
        "Queued",
        "Started",
        "Failed",
        "Succeeded",
        "Unknown"
    ],
    "type": "string",
    "description": "Specifies the status of an operation."
}

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

Operation

Operation Response

Operation Status

Error

Error Response