Create Task Links - Schedules

Schedules

Download API definition:

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

POST https://dev-api.bentley.com/schedules/{scheduleId}/task-links/batch

Create multiple Task Links for a Schedule.

Task Link

Task Links show the logical and scheduling dependencies between activities within a plan. Links between two Tasks define a dependency between one Task and another. They are used to explicitly prevent tasks from being worked on out of sequence or offset the start/finish of one versus another.

V10 Endpoint

This endpoint is only supported by v10 schedules. The schedule type can be identified by querying the /schedules/{scheduleId} endpoint.

Operation

Operations, also known as LROs (Long Running Operations), are time-consuming tasks that would not be completed in the appropriate timeframe for a single request response. Endpoints that use operations return an operation id that can be used on a separate endpoint to track the progress of the task that is being handled.

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

Request parameters

scheduleId

Yes

The unique identifier of the Schedule.

Request headers

Authorization

Yes

OAuth access token with itwin-platform scope

Yes

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Entity to post for creation.

Request body

Task Links Create Request

batch

TaskLinkCreateRequest[]

Container of the Task Links to be created.

Example

json

{
    "batch": [{
            "calendarId": "730fc10e-183d-4b44-ace9-b44106190439",
            "lag": 10,
            "predecessorId": "42aa53f0-d4ad-4ec4-826b-fc6439090d46",
            "successorId": "91c3aaab-5c86-43ec-870d-6c34949ab1f3",
            "type": "FinishToStart"
        },
        {
            "predecessorId": "42aa53f0-d4ad-4ec4-826b-fc6439090d46",
            "successorId": "4e927d7a-6a9a-4a93-a75d-cbe60133cdd4",
            "type": "StartToFinish"
        }
    ]
}

Response

Response 200 OK

This response indicates that the Task Links were Created.

json

{
    "batch": [{
            "calendarId": "730fc10e-183d-4b44-ace9-b44106190439",
            "createdOn": "2025-01-29T11:19:00Z",
            "deleted": false,
            "id": "7a557883-b83a-47fd-b157-feaa5449ffc3",
            "lag": 10,
            "predecessorId": "42aa53f0-d4ad-4ec4-826b-fc6439090d46",
            "successorId": "91c3aaab-5c86-43ec-870d-6c34949ab1f3",
            "type": "FinishToStart"
        },
        {
            "calendarId": "584728ee-6aec-4289-8e96-8fbee7185d32",
            "createdOn": "2025-01-29T11:19:00Z",
            "deleted": false,
            "id": "ec3e871c-83a0-4e81-94ed-4713054a0431",
            "lag": 0,
            "predecessorId": "42aa53f0-d4ad-4ec4-826b-fc6439090d46",
            "successorId": "4e927d7a-6a9a-4a93-a75d-cbe60133cdd4",
            "type": "StartToFinish"
        }
    ],
    "operation": {
        "id": "1604789f-68c4-46ba-b20d-8a19f8319362"
    },
    "_links": {
        "operationLocation": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/operations/1604789f-68c4-46ba-b20d-8a19f8319362"
        }
    }
}

Response headers

Operation-Id

The unique identifier of the Operation.

Operation-Location

URL to the Operations endpoint with pre-entered Operation ID.

Response 202 Accepted

This response indicates that the requested long-running operation was Accepted.

json

{
    "batch": [{
            "id": "91c3aaab-5c86-43ec-870d-6c34949ab1f3"
        },
        {
            "id": "4e927d7a-6a9a-4a93-a75d-cbe60133cdd4"
        }
    ],
    "operation": {
        "id": "1604789f-68c4-46ba-b20d-8a19f8319362"
    },
    "_links": {
        "operationLocation": {
            "href": "https://api.bentley.com/schedules/5e11b21e-cba2-48a8-a2c1-2977d2d373e0/operations/1604789f-68c4-46ba-b20d-8a19f8319362"
        }
    }
}

Response headers

Operation-Id

The unique identifier of the Operation.

Operation-Location

URL to the Operations endpoint with pre-entered Operation ID.

Response 400 Bad Request

The 400 (Bad Request) 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": "InvalidRequestBody",
            "message": "The 'batch' property must not contain more than 200 items."
        }],
        "message": "The request contains invalid properties."
    }
}

Response 401 Unauthorized

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 403 Forbidden

User is not authorized to create a Task Links.

json

{
    "error": {
        "code": "InsufficientPermissions",
        "message": "The user has insufficient permissions for the requested operation."
    }
}

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

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

Operation Create Response Properties

Contains the id of the created long-running operation.

String, null

The unique identifier of the Operation.

json

{
    "title": "Operation Create Response Properties",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Operation.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Contains the id of the created long-running operation."
}

Operation Location

Contains the URL to the Operations endpoint to check the information about a long-running operation.

operationLocation

Link

URL to the Operations endpoint with pre-entered Operation ID.

json

{
    "title": "Operation Location",
    "type": "object",
    "properties": {
        "operationLocation": {
            "$ref": "#/components/schemas/Link",
            "description": "URL to the Operations endpoint with pre-entered Operation ID."
        }
    },
    "additionalProperties": false,
    "description": "Contains the URL to the Operations endpoint to check the information about a long-running operation."
}

Task Link

Representation of a Task Link.

calendarId

String

Unique identifier of the Calendar on which to define the Delay.

createdOn

Date, null

The date on which the Task Link was created.

deleted

Boolean, null

Is this Task Link deleted.

String

The unique identifier of the Task Link.

lag

Int32

The minimum amount of time set to constrain one Task from another. Negative lag is indicated with a negative sign (-).

predecessorId

String

The unique identifier of the predecessor Task.

successorId

String

The unique identifier of the successor Task.

type

TaskLinkType

Task Link Type.

json

{
    "title": "Task Link",
    "type": "object",
    "properties": {
        "calendarId": {
            "type": "string",
            "description": "Unique identifier of the Calendar on which to define the Delay."
        },
        "createdOn": {
            "type": "string",
            "description": "The date on which the Task Link was created.",
            "format": "date",
            "nullable": true
        },
        "deleted": {
            "type": "boolean",
            "description": "Is this Task Link deleted.",
            "nullable": true
        },
        "id": {
            "type": "string",
            "description": "The unique identifier of the Task Link."
        },
        "lag": {
            "type": "integer",
            "description": "The minimum amount of time set to constrain one Task from another. Negative lag is indicated with a negative sign (-).",
            "format": "int32"
        },
        "predecessorId": {
            "type": "string",
            "description": "The unique identifier of the predecessor Task."
        },
        "successorId": {
            "type": "string",
            "description": "The unique identifier of the successor Task."
        },
        "type": {
            "$ref": "#/components/schemas/TaskLinkType",
            "description": "Task Link Type."
        }
    },
    "additionalProperties": false,
    "description": "Representation of a Task Link."
}

Task Link Create Request

Task Link properties for creation.

calendarId

String, null

Unique identifier of the Calendar on which to define the Delay.

String, null

Unique identifier of the Task Link.

lag

Int32, null

The minimum amount of time set to constrain one Task from another. Negative lag is indicated with a negative sign (-).

predecessorId

String

Unique identifier of the predecessor Task.

successorId

String

Unique identifier of the successor Task.

type

TaskLinkType

Task Link Type.

json

{
    "title": "Task Link Create Request",
    "type": "object",
    "properties": {
        "calendarId": {
            "type": "string",
            "description": "Unique identifier of the Calendar on which to define the Delay.",
            "nullable": true
        },
        "id": {
            "type": "string",
            "description": "Unique identifier of the Task Link.",
            "nullable": true
        },
        "lag": {
            "type": "integer",
            "description": "The minimum amount of time set to constrain one Task from another. Negative lag is indicated with a negative sign (-).",
            "format": "int32",
            "nullable": true
        },
        "predecessorId": {
            "type": "string",
            "description": "Unique identifier of the predecessor Task."
        },
        "successorId": {
            "type": "string",
            "description": "Unique identifier of the successor Task."
        },
        "type": {
            "$ref": "#/components/schemas/TaskLinkType",
            "description": "Task Link Type."
        }
    },
    "additionalProperties": false,
    "description": "Task Link properties for creation."
}

Task Link Type

The link type: Finish to Start, Finish to Finish, Start to Start, or Start to Finish.

FinishToStart

String

StartToFinish

String

StartToStart

String

FinishToFinish

String

Unknown

String

json

{
    "title": "Task Link Type",
    "enum": [
        "FinishToStart",
        "StartToFinish",
        "StartToStart",
        "FinishToFinish",
        "Unknown"
    ],
    "type": "string",
    "description": "The link type: Finish to Start, Finish to Finish, Start to Start, or Start to Finish."
}

Task Links Create Operation Response

Container of Task Links creation Operation.

batch

TaskLinksResponseProperties[]

Properties of the Task Links in the Operation.

operation

OperationCreateResponseProperties, null

Contains properties of the created long-running operation.

_links

OperationLocationLink, null

Contains the hyperlink to the Operations endpoint to check the operation information.

json

{
    "title": "Task Links Create Operation Response",
    "type": "object",
    "properties": {
        "batch": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskLinksResponseProperties"
            },
            "description": "Properties of the Task Links in the Operation."
        },
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties",
            "description": "Contains properties of the created long-running operation.",
            "nullable": true
        },
        "_links": {
            "$ref": "#/components/schemas/OperationLocationLink",
            "description": "Contains the hyperlink to the Operations endpoint to check the operation information.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Container of Task Links creation Operation.",
    "x-codegen-extends-class": "OperationCreateResponse"
}

Task Links Create Request

Container of the Task Links to be created.

batch

TaskLinkCreateRequest[]

Container of the Task Links to be created.

json

{
    "title": "Task Links Create Request",
    "type": "object",
    "properties": {
        "batch": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskLinkCreateRequest"
            },
            "description": "Container of the Task Links to be created."
        }
    },
    "additionalProperties": false,
    "description": "Container of the Task Links to be created."
}

Task Links Create Response

Contains properties of the created Task Links.

batch

TaskLink[]

A list of created Task Links.

operation

OperationCreateResponseProperties, null

Contains properties of the created long-running operation.

_links

OperationLocationLink, null

Contains the hyperlink to the Operations endpoint to check the operation information.

json

{
    "title": "Task Links Create Response",
    "type": "object",
    "properties": {
        "batch": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/TaskLink"
            },
            "description": "A list of created Task Links."
        },
        "operation": {
            "$ref": "#/components/schemas/OperationCreateResponseProperties",
            "description": "Contains properties of the created long-running operation.",
            "nullable": true
        },
        "_links": {
            "$ref": "#/components/schemas/OperationLocationLink",
            "description": "Contains the hyperlink to the Operations endpoint to check the operation information.",
            "nullable": true
        }
    },
    "additionalProperties": false,
    "description": "Contains properties of the created Task Links.",
    "x-codegen-extends-class": "OperationCreateResponse"
}

Task Links Response Properties

Contains properties of the Task Link that is queued for the Operation.

String

The unique identifier of the Task Link.

json

{
    "title": "Task Links Response Properties",
    "type": "object",
    "properties": {
        "id": {
            "type": "string",
            "description": "The unique identifier of the Task Link."
        }
    },
    "additionalProperties": false,
    "description": "Contains properties of the Task Link that is queued for the Operation."
}

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
}