Get Task Status - Schedules

Schedules

Download API definition:

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

Get Task Status

GET https://dev-api.bentley.com/schedules/{scheduleId}/task-statuses/{taskStatusId}

Gets the details of a Task Status.

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

taskStatusId

Yes

The Id of the task status.

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

{
    "taskStatus": {
        "color": "#ffff00",
        "id": "7a557883-b83a-47fd-b157-feaa5449ffc3",
        "isDefault": true,
        "name": "Planned",
        "type": "Planned"
    }
}

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 Task Status or 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

Task Status

Representation of a Task Status.

color

String

The color of a Task in the Gantt Chart when this Task Status is applied.

String

The unique identifier of the Task Status.

isDefault

Boolean

Is this Task Status the default status of a new task.

name

String

The name of the Task Status.

type

TaskStatusType

Specifies the current status of the Task.

json

{
    "title": "Task Status",
    "type": "object",
    "properties": {
        "color": {
            "type": "string",
            "description": "The color of a Task in the Gantt Chart when this Task Status is applied.",
            "example": "#ffff00"
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Task Status."
        },
        "isDefault": {
            "type": "boolean",
            "description": "Is this Task Status the default status of a new task."
        },
        "name": {
            "type": "string",
            "description": "The name of the Task Status."
        },
        "type": {
            "$ref": "#/components/schemas/TaskStatusType",
            "description": "Specifies the current status of the Task."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a Task Status."
}

Task Status Response

Container for a Task Status object.

taskStatus

TaskStatus

Task Status properties.

json

{
    "title": "Task Status Response",
    "type": "object",
    "properties": {
        "taskStatus": {
            "$ref": "#/components/schemas/TaskStatus",
            "description": "Task Status properties."
        }
    },
    "additionalProperties": false,
    "description": "Container for a Task Status object."
}

Task Status Type

Task status type specifies the current status of the Task.

Planned

String

Started

String

Finished

String

Unknown

String

json

{
    "title": "Task Status Type",
    "enum": [
        "Planned",
        "Started",
        "Finished",
        "Unknown"
    ],
    "type": "string",
    "description": "Task status type specifies the current status of the Task."
}

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

Task Status

Task Status Response

Task Status Type

Error

Error Response