Get Tasks - Schedules | iTwin Platform

NoConstraint: The Task can be set to start at any date/time you choose.
CannotReschedule: The Task cannot have its start or finish date changed.
StartAsap: The Task will automatically spring back to start as soon as possible (ASAP), i.e to its Early Start Date.
StartAlap: The Task will automatically spring forward to start as late as possible (ALAP), i.e to its Late Start Date.
StartOn: Tasks Dependencies have a greater priority than the specified Start Date such that the Task may actually start at ANY time.
StartAfter: Tasks Dependencies have a greater priority than the specified Start Date such that the Task may actually start On or After the specified Start Date.
StartBefore: Tasks Dependencies have a greater priority than the specified Start Date such that the Task may actually start On or Before the specified Start Date.
StartBetween: Tasks Dependencies have a greater priority than the specified Start Date such that the Task may actually start at between the Late Start Date and the Early Start Date.
FinishOn: Tasks Dependencies have a greater priority than the specified Finish Date such that the Task may actually finish at ANY time.
FinishAfter: Tasks Dependencies have a greater priority than the specified Finish Date such that the Task may actually finish On or After the specified Finish Date.
FinishBefore: Tasks Dependencies have a greater priority than the specified Finish Date such that the Task may actually finish On or Before the specified Finish Date.
FinishBetween: Tasks Dependencies have a greater priority than the specified Finish Date such that the Task may actually finish between the Late Finish Date and the Early Finish Date.
MandatoryStart: The defined Start Date has a greater priority than any Task dependency to ensure that the Task starts on the specified date.
MandatoryFinish: The defined Finish Date has a greater priority than any Task dependency to ensure that the Task finishes on the specified date.
WorkBetween: Tasks Dependencies have a greater priority than the specified Start and Finish Dates such that the Task may actually start On or After the specified Start Date and finish On or Before the specified Finish Date.
WorkOut: Tasks Dependencies have a greater priority than the specified Start and Finish Dates such that the Task may actually start On or Before the specified Start Date and finish On or After the specified Finish Date.

Task Progress Types

Each Task has a progress type, which specifies how progress is determined.

Automatic: Percent Complete is tied to duration and calculated automatically based on Task dates, and current time. Changing the Percent Complete value leads to creation of a delay or advance report.
Manual: Percent Complete should be set manually. Changing the Percent Complete has no effect on other parameters.
Duration: Percent Complete is tied to duration, calculated based on planned and remaining duration. Changing the Percent Complete leads to recalculation of remaining duration.
Physical: Percent Complete is tied to Physical Quantity, calculated as Actual Physical Quantity / (Actual Physical Quanitity + Remaining Physical Quantity). Changing the Percent Complete leads to recalculation of actual Physical Quantity.
Unit: Percent Complete is tied to units of assigned equipment and human resources, calculated based on actual and remaining units of assigned equipment and human resources (material and location resources are not taken into account). Changing the Percent Complete leads to recalculation of actual units.

Task Duration Types

Each Task has a duration type, which specifies how Task Duration is determined.

Fixed: User enters Task Duration manually.
PhysicalQuantityDependent: Task Duration is calculated based on user-entered Physical Quantity (eg. square feet of wall to paint, cubic metres of concrete to pour) and assigned production rate Rule.
ResourceUnitDependent: Task Duration is calculated based on required man or machine-hours and Utilisation Percentage for a selected Driving Resource.

Task Types

Tasks can be of differing types. The following Task types have different behaviors:

Work: The default Task type. Work represents an expenditure of effort and resources achieving the Task. Work type Tasks have a Start, Finish and a Duration.
StartKeyDate: A Project Milestone - setting a Task as a Key Date will also change its representation in the Gantt Chart to a diamond, and give the Task a zero duration. Start Key Dates have no Finish Date or Duration.
FinishKeyDate: A Project Milestone - setting a Task as a Key Date will also change its representation in the Gantt Chart to a diamond, and give the Task a zero duration. Finish Key Dates have no Start Date or Duration.
ShortHammock: Spans the shortest duration between all its predecessor and successor Tasks. The Start, Finish, and Duration of the Short Hammock is derived from its predecessor and successor Tasks and cannot be edited directly.
LongHammock: Spans the longest duration between all its predecessor and successor Tasks. The Start, Finish, and Duration of the Long Hammock is derived from its predecessor and successor Tasks and cannot be edited directly

The remaining Task Types behave the same as the Work type and can be used to help label Tasks.

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

{
    "tasks": [{
            "actualDuration": 230400,
            "actualFinish": "2019-11-15T12:00:00Z",
            "actualPhysicalQuantity": 0,
            "actualStart": "2019-11-04T12:00:00Z",
            "comment": "Comment about demolishing",
            "constraintEarlyDate": "2019-11-04T08:00:00Z",
            "constraintLateDate": null,
            "constraintType": "StartAfter",
            "durationType": "Fixed",
            "estimatedRate": 0,
            "expectedFinish": null,
            "id": "fc3673d9-e385-4031-abbe-663535a329f5",
            "isWbs": false,
            "name": "Demolish Old Building",
            "parentId": "e3e4f597-8b58-4c0a-8931-1f3f55a7b34b",
            "percentComplete": 100,
            "physicalQuantity": 0,
            "physicalQuantityUnit": "Unknown",
            "plannedDuration": 144000,
            "plannedFinish": "2019-12-06T05:00:00Z",
            "plannedStart": "2019-12-02T08:00:00Z",
            "progressType": "Duration",
            "remainingDuration": null,
            "remainingPhysicalQuantity": 0,
            "status": "Finished",
            "statusId": "20cf6c69-b9df-422a-a509-a164c59d668b",
            "type": "Work",
            "url": "",
            "userDefinedId": "D256"
        },
        {
            "actualDuration": 3024000,
            "actualFinish": "2020-12-23T05:00:00Z",
            "actualPhysicalQuantity": 0,
            "actualStart": "2020-07-24T12:00:00Z",
            "comment": null,
            "constraintEarlyDate": null,
            "constraintLateDate": null,
            "constraintType": "NoConstraint",
            "durationType": "Fixed",
            "estimatedRate": 0,
            "expectedFinish": "2020-12-23T05:00:00Z",
            "id": "04048a8d-0747-47e9-af1b-147df7a4a387",
            "isWbs": false,
            "name": "Building Engineering",
            "parentId": "39aade8a-c723-493b-a79e-cf9d8e7af8af",
            "percentComplete": 58,
            "physicalQuantity": 0,
            "physicalQuantityUnit": "Unknown",
            "plannedDuration": 4032000,
            "plannedFinish": "2020-12-18T05:00:00Z",
            "plannedStart": "2020-06-01T08:00:00Z",
            "progressType": "Duration",
            "remainingDuration": 1670400,
            "remainingPhysicalQuantity": 0,
            "status": "Started",
            "statusId": "9813f16a-cb65-819d-aca3-81de9135f133",
            "type": "Work",
            "url": "",
            "userDefinedId": "E864"
        },
        {
            "actualDuration": null,
            "actualFinish": null,
            "actualPhysicalQuantity": 0,
            "actualStart": null,
            "comment": "Comment of Task 8",
            "constraintEarlyDate": "2021-03-08T05:00:00Z",
            "constraintLateDate": "2021-03-08T05:00:00Z",
            "constraintType": "FinishBetween",
            "durationType": "ResourceUnitsDependent",
            "estimatedRate": 194.125,
            "expectedFinish": "2021-03-24T05:00:00Z",
            "id": "5bd8e476-dbaa-4cf5-ba95-3069cc3bcc4d",
            "isWbs": false,
            "name": "Task 8",
            "parentId": null,
            "percentComplete": 0,
            "physicalQuantity": 1553,
            "physicalQuantityUnit": "Pair",
            "plannedDuration": 28800,
            "plannedFinish": "2021-03-08T05:00:00Z",
            "plannedStart": "2021-03-08T09:00:00Z",
            "progressType": "Automatic",
            "remainingDuration": null,
            "remainingPhysicalQuantity": 1553,
            "status": "Planned",
            "statusId": "913fa516-5009-4201-bbf3-808d09dcb218",
            "type": "Work",
            "url": "https://example.com",
            "userDefinedId": "ST00100"
        }
    ],
    "_links": {
        "self": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/tasks?$top=3"
        },
        "next": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/tasks?$top=3&$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

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."
}

Resource Unit Type

The possible unit types for resources.

CubicFeet

String

CubicMeter

String

Liter

String

Millimeter

String

Meter

String

Feet

String

Each

String

Pair

String

Dozen

String

Gross

String

SqFoot

String

SqYard

String

SqMeter

String

Pound

String

Gram

String

Kilo

String

Bag

String

Box

String

Bucket

String

Bundle

String

Card

String

Carton

String

Coil

String

Pack

String

Pegs

String

Length

String

Outer

String

Pallet

String

Roll

String

Sachet

String

Set

String

Sheet

String

Ton

String

Person

String

Item

String

CubicYard

String

MetricTon

String

Hour

String

LinearMeter

String

Unknown

String

json

{
    "title": "Resource Unit Type",
    "enum": [
        "CubicFeet",
        "CubicMeter",
        "Liter",
        "Millimeter",
        "Meter",
        "Feet",
        "Each",
        "Pair",
        "Dozen",
        "Gross",
        "SqFoot",
        "SqYard",
        "SqMeter",
        "Pound",
        "Gram",
        "Kilo",
        "Bag",
        "Box",
        "Bucket",
        "Bundle",
        "Card",
        "Carton",
        "Coil",
        "Pack",
        "Pegs",
        "Length",
        "Outer",
        "Pallet",
        "Roll",
        "Sachet",
        "Set",
        "Sheet",
        "Ton",
        "Person",
        "Item",
        "CubicYard",
        "MetricTon",
        "Hour",
        "LinearMeter",
        "Unknown"
    ],
    "type": "string",
    "description": "The possible unit types for resources."
}

Task

Representation of a Task.

actualDuration

Int32, null

The amount of time actually consumed in performing the activity. The value is a timestamp of seconds.

actualFinish

Date-time, null

The date on which the activity actually finished.

actualPhysicalQuantity

Double

The physical quantity completed to date.

actualStart

Date-time, null

The date on which the activity is actually started.

comment

String, null

The comment of the Task.

constraintEarlyDate

Date-time, null

Early date in the date range for Task Constraint Types: StartBetween, FinishBetween, WorkBetween, WorkOut.

constraintLateDate

Date-time, null

Late date in the date range for Task Constraint Types: StartBetween, FinishBetween, WorkBetween, WorkOut.

constraintType

TaskConstraintType

Task Constraints determine the rules under which a Task can be started and rescheduled.

durationType

TaskDurationType

The Duration Type of a Task specifies how the Task duration will be calculated.

estimatedRate

Double

The estimated production rate to accomplish the given Physical Quantity in the given Duration (when Duration Type is Fixed).

expectedFinish

Date-time, null

The expected Task End Date, based upon the Actual Start plus the Percent Complete and Remaining Duration.

String

The unique identifier of the Task.

isWbs

Boolean

Is Task a Work Breakdown Structure (WBS).

name

String

The name of the Task.

parentId

String, null

The unique identifier of the parent Task.

percentComplete

Int32

The due level of progress for the Task as a percentage of its overall duration. Depends on the Progress Type selected.

physicalQuantity

Double

The total quantity required by the Task, used to calculate the duration of a Physical Quantity Dependent Task.

physicalQuantityUnit

ResourceUnitType

The unit used to measure the Physical Quantity assigned to the Task.

plannedDuration

Int32

The time allotted to complete a Task. It can only change for Tasks with Planned Status. The value is a timestamp of seconds.

plannedFinish

Date-time

The Finish Date according to the current project schedule. It can only change for Tasks with Planned Status.

plannedStart

Date-time

The Start Date according to the current project schedule. It can only change for Tasks with Planned Status.

progressType

TaskProgressType

This value specifies way that Progress is determined.

remainingDuration

Int32, null

The amount of work time required to complete the Task. It is automatically calculated from the Percent Complete or can be entered manually once a Task has been Started. The value is a timestamp of seconds.

remainingPhysicalQuantity

Double

The physical quantity required to complete the Task.

status

TaskStatusType

The current Task status.

statusId

String

The unique identifier of the Task Status.

type

TaskType

Task Type provides a categorization (or classification) of project Tasks.

url

String

A URL associated with the Task.

userDefinedId

String

A unique Task Id defined by the user.

json

{
    "title": "Task",
    "type": "object",
    "properties": {
        "actualDuration": {
            "type": "integer",
            "description": "The amount of time actually consumed in performing the activity. The value is a timestamp of seconds.",
            "format": "int32",
            "nullable": true
        },
        "actualFinish": {
            "type": "string",
            "description": "The date on which the activity actually finished.",
            "format": "date-time",
            "nullable": true
        },
        "actualPhysicalQuantity": {
            "type": "number",
            "description": "The physical quantity completed to date.",
            "format": "double"
        },
        "actualStart": {
            "type": "string",
            "description": "The date on which the activity is actually started.",
            "format": "date-time",
            "nullable": true
        },
        "comment": {
            "type": "string",
            "description": "The comment of the Task.",
            "nullable": true
        },
        "constraintEarlyDate": {
            "type": "string",
            "description": "Early date in the date range for Task Constraint Types: StartBetween, FinishBetween, WorkBetween, WorkOut.",
            "format": "date-time",
            "nullable": true
        },
        "constraintLateDate": {
            "type": "string",
            "description": "Late date in the date range for Task Constraint Types: StartBetween, FinishBetween, WorkBetween, WorkOut.",
            "format": "date-time",
            "nullable": true
        },
        "constraintType": {
            "$ref": "#/components/schemas/TaskConstraintType",
            "description": "Task Constraints determine the rules under which a Task can be started and rescheduled."
        },
        "durationType": {
            "$ref": "#/components/schemas/TaskDurationType",
            "description": "The Duration Type of a Task specifies how the Task duration will be calculated."
        },
        "estimatedRate": {
            "type": "number",
            "description": "The estimated production rate to accomplish the given Physical Quantity in the given Duration (when Duration Type is Fixed).",
            "format": "double"
        },
        "expectedFinish": {
            "type": "string",
            "description": "The expected Task End Date, based upon the Actual Start plus the Percent Complete and Remaining Duration.",
            "format": "date-time",
            "nullable": true
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Task."
        },
        "isWbs": {
            "type": "boolean",
            "description": "Is Task a Work Breakdown Structure (WBS)."
        },
        "name": {
            "type": "string",
            "description": "The name of the Task."
        },
        "parentId": {
            "type": "string",
            "description": "The unique identifier of the parent Task.",
            "nullable": true
        },
        "percentComplete": {
            "type": "integer",
            "description": "The due level of progress for the Task as a percentage of its overall duration. Depends on the Progress Type selected.",
            "format": "int32"
        },
        "physicalQuantity": {
            "type": "number",
            "description": "The total quantity required by the Task, used to calculate the duration of a Physical Quantity Dependent Task.",
            "format": "double"
        },
        "physicalQuantityUnit": {
            "$ref": "#/components/schemas/ResourceUnitType",
            "description": "The unit used to measure the Physical Quantity assigned to the Task."
        },
        "plannedDuration": {
            "type": "integer",
            "description": "The time allotted to complete a Task. It can only change for Tasks with Planned Status. The value is a timestamp of seconds.",
            "format": "int32"
        },
        "plannedFinish": {
            "type": "string",
            "description": "The Finish Date according to the current project schedule. It can only change for Tasks with Planned Status.",
            "format": "date-time"
        },
        "plannedStart": {
            "type": "string",
            "description": "The Start Date according to the current project schedule. It can only change for Tasks with Planned Status.",
            "format": "date-time"
        },
        "progressType": {
            "$ref": "#/components/schemas/TaskProgressType",
            "description": "This value specifies way that Progress is determined."
        },
        "remainingDuration": {
            "type": "integer",
            "description": "The amount of work time required to complete the Task. It is automatically calculated from the Percent Complete or can be entered manually once a Task has been Started. The value is a timestamp of seconds.",
            "format": "int32",
            "nullable": true
        },
        "remainingPhysicalQuantity": {
            "type": "number",
            "description": "The physical quantity required to complete the Task.",
            "format": "double"
        },
        "status": {
            "$ref": "#/components/schemas/TaskStatusType",
            "description": "The current Task status."
        },
        "statusId": {
            "type": "string",
            "description": "The unique identifier of the Task Status."
        },
        "type": {
            "$ref": "#/components/schemas/TaskType",
            "description": "Task Type provides a categorization (or classification) of project Tasks."
        },
        "url": {
            "type": "string",
            "description": "A URL associated with the Task."
        },
        "userDefinedId": {
            "type": "string",
            "description": "A unique Task Id defined by the user."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a Task."
}

Task Constraint Type

Task Constraints determine the rules under which a Task can be started and rescheduled. See the Task Constraint Types section for details.

NoConstraint

String

CannotReschedule

String

StartAsap

String

StartAlap

String

StartOn

String

StartAfter

String

StartBefore

String

StartBetween

String

FinishOn

String

FinishAfter

String

FinishBefore

String

FinishBetween

String

MandatoryStart

String

MandatoryFinish

String

WorkBetween

String

WorkOut

String

Unknown

String

json

{
    "title": "Task Constraint Type",
    "enum": [
        "NoConstraint",
        "CannotReschedule",
        "StartAsap",
        "StartAlap",
        "StartOn",
        "StartAfter",
        "StartBefore",
        "StartBetween",
        "FinishOn",
        "FinishAfter",
        "FinishBefore",
        "FinishBetween",
        "MandatoryStart",
        "MandatoryFinish",
        "WorkBetween",
        "WorkOut",
        "Unknown"
    ],
    "type": "string",
    "description": "Task Constraints determine the rules under which a Task can be started and rescheduled. See the [Task Constraint Types](#task-constraint-types) section for details."
}

Task Duration Type

The Task duration type value specifies way that Task Duration is determined. See the Task Duration Types section for details.

Fixed

String

PhysicalQuantityDependent

String

ResourceUnitsDependent

String

Unknown

String

json

{
    "title": "Task Duration Type",
    "enum": [
        "Fixed",
        "PhysicalQuantityDependent",
        "ResourceUnitsDependent",
        "Unknown"
    ],
    "type": "string",
    "description": "The Task duration type value specifies way that Task Duration is determined. See the [Task Duration Types](#task-duration-types) section for details."
}

Task Progress Type

The Task progress type value specifies way that Task Progress is determined. See the Task Progress Types section for details.

Automatic

String

Manual

String

Duration

String

Physical

String

Unit

String

Unknown

String

json

{
    "title": "Task Progress Type",
    "enum": [
        "Automatic",
        "Manual",
        "Duration",
        "Physical",
        "Unit",
        "Unknown"
    ],
    "type": "string",
    "description": "The Task progress type value specifies way that Task Progress is determined. See the [Task Progress Types](#task-progress-types) section for details."
}

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."
}

Task Type

Task Type provides a categorization (or classification) of project Tasks. See the Task Types section for details.

Work

String

StartKeyDate

String

FinishKeyDate

String

ShortHammock

String

LongHammock

String

Rfi

String

ChangeOrder

String

Testing

String

Delivery

String

Meeting

String

Rework

String

Design

String

Maintenance

String

Manufacture

String

Storage

String

Purchase

String

Receive

String

Delay

String

WeatherDelay

String

Unknown

String

json

{
    "title": "Task Type",
    "enum": [
        "Work",
        "StartKeyDate",
        "FinishKeyDate",
        "ShortHammock",
        "LongHammock",
        "Rfi",
        "ChangeOrder",
        "Testing",
        "Delivery",
        "Meeting",
        "Rework",
        "Design",
        "Maintenance",
        "Manufacture",
        "Storage",
        "Purchase",
        "Receive",
        "Delay",
        "WeatherDelay",
        "Unknown"
    ],
    "type": "string",
    "description": "Task Type provides a categorization (or classification) of project Tasks. See the [Task Types](#task-types) section for details."
}

Tasks Response

List of Tasks.

tasks

Task[]

A list of Tasks.

_links

PagingLinks

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

json

{
    "title": "Tasks Response",
    "type": "object",
    "properties": {
        "tasks": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/Task"
            },
            "description": "A list of Tasks."
        },
        "_links": {
            "$ref": "#/components/schemas/PagingLinks",
            "description": "Contains the hyperlinks to the current and next pages of results."
        }
    },
    "additionalProperties": false,
    "description": "List of Tasks."
}

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

Task Constraint Types

Task Progress Types

Task Duration Types

Task Types

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

Link

Paging Links

Resource Unit Type

Task

Task Constraint Type

Task Duration Type

Task Progress Type

Task Status Type

Task Type

Tasks Response

DetailedError

Detailed Error Response

Error

Error Response