API ReferenceTask

Create Task

Create a new Task within a specified project. A Task is an individual element of work that must be performed to complete a Project. A Task can have one or more Resources assigned to it. Tasks can be linked to other Tasks to indicate whether they have a dependency or a connection.

Path parameters

projectIdstringRequired
The unique identifier of the Project that will contain this Task

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringRequired
The common name of this Task.
idstringOptional

The unique identifier of this Task.

TODO - Are people allowed to set this when creating a task? Doesn’t that violate the principle of GUIDs?

descriptionstringOptional
A description of the work to be performed in this Task.
parentTaskIdstringOptional
If this Task is the child of another Task, set this value to the unique identifier of the parent Task.
percentCompleteintegerOptional

The numerical percentage, from 0-100, representing the percentage completion for this Task. Any numbers below zero or above 100 will be clamped to the minimum or maximum value.

This value can be edited manually in the Gantt chart view of the application, or can be selected on the Task Detail page within the Kanban board.

statusIdstringOptional
The unique identifier of the TaskStatus for this Task
priorityIdintegerOptional
A numerical value representing the Priority of this Task
assigneeslist of stringsOptional
A list of unique identifiers of TaskAssignees to be assigned to this Task
plannedStartDatestringOptional
The date when work on this Task is planned to begin.
plannedFinishDatestringOptional
The date when work on this Task is expected to complete.
plannedDurationintegerOptional

The planned duration (in minutes) for this Task. Cannot be negative.

plannedEffortintegerOptional

The planned effort (in minutes) for this Task. Cannot be negative.

plannedCostdoubleOptional
The planned cost for this Task. Cannot be negative.
actualStartDatestringOptional
The date when work on this Task actually started, if known.
actualCostdoubleOptional
The actual cost of this Task to date, if known.

Response

This endpoint returns an object.
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeenum or null
The HTTP code of the response.
dataobject or null
Returns the id of a specific ChangeSet