API ReferenceTask Link

Create Task Link

Creates a new link (dependency) from this Task to another Task in the same Project. A Task Link connects a predecessor Task to a successor Task, indicating a scheduling dependency between them. The link type controls how the two Tasks' dates relate to each other, and lag adds (or, if negative, removes) time between them. Valid LinkType values (case-insensitive): finishToStart, startToStart, finishToFinish, startToFinish. Omitting LinkType defaults to finishToStart.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

taskIdstringRequiredformat: "uuid"
The unique identifier of the predecessor Task for this link

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

The Task to link to, along with the link type and lag
successorTaskIdstringOptionalformat: "uuid"
The unique identifier of the successor Task to link to. This Task must be in the same Project as the predecessor Task the link is being created from.
linkTypestringOptional

The type of dependency between the two Tasks. Case-insensitive; stored and returned in camelCase.

Valid values: finishToStart, startToStart, finishToFinish, startToFinish. Defaults to finishToStart when omitted.

lagintegerOptional-1000-1000

The number of days of lag (or lead, if negative) between the two Tasks.

Response

Success
errorobject or nullOptional
If the API call failed, this will contain information about the error that occurred.
successbooleanOptionalRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanOptionalRead-only
True if the API call failed.
statusCodeenumOptional
The HTTP code of the response.
dataobjectOptional
Returns the id of a specific ChangeSet