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.

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequiredformat: "uuid"
The unique identifier of the Project that will contain this Task

Headers

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

Request

The new Task to create
namestringRequired>=1 character
The common name of this Task.
descriptionstring or nullOptional
A description of the work to be performed in this Task.
percentCompleteinteger or nullOptional0-100

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.

statusIdstring or nullOptionalformat: "uuid"
The unique identifier of the TaskStatus for this Task
priorityIdinteger or nullOptional
A numerical value representing the Priority of this Task
assigneeslist of strings or nullOptional
A list of unique identifiers of TaskAssignees to be assigned to this Task
plannedStartDatestring or nullOptionalformat: "date"
The date when work on this Task is planned to begin.
plannedFinishDatestring or nullOptionalformat: "date"
The date when work on this Task is expected to complete.
plannedDurationinteger or nullOptional0-6570000

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

plannedEffortinteger or nullOptional0-2147483647

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

plannedCostdouble or nullOptional>=0
The planned cost for this Task. Cannot be negative.
actualStartDatestring or nullOptionalformat: "date"
The date when work on this Task actually started, if known.
actualCostdouble or nullOptional>=0
The actual cost of this Task to date, if known.
themestring or nullOptional
Color theme definition for this task. eg. Blue, Brown, DarkBlue, DarkGrey, Gold, Green, Grey, LightBrown, LightGreen, LightGrey, LightPurple, LightYellow, Magenta, Mauve, Navy, Orange, Purple, Red.
isLockedboolean or nullOptional

Unlocked tasks can be adjusted by changes to their dependencies, resource leveling, or other factors.

All tasks are unlocked by default.

If a task is set to IsLocked = true, the dates and assigned resources are locked for this task and will not be automatically changed by any process.

isMilestoneboolean or nullOptional
True if this task is a milestone. Milestones represent a specific point in time for the project. When a milestone is locked, it represents a fixed time within the project that can be used to relate to other tasks.
parentIdstring or nullOptionalformat: "uuid"

Gets or sets the unique identifier of the parent task. If set, this task will be a child of the specified parent task, supporting task hierarchies and sub-tasks.

indexinteger or nullOptional
Gets or sets the position of the task within the list of project tasks. Used to determine the order of tasks in the project with the first task being 1.

Response

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

True if the API call succeeded; false otherwise.

hasErrorbooleanRead-only
True if the API call failed.
statusCodeenum
The HTTP code of the response.
dataobject
Returns the id of a specific ChangeSet