API ReferenceTask

Create Many Tasks

Create multiple new Tasks within a specified project with a single API call. 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

projectIdstringRequiredformat: "uuid"
The unique identifier of the Project that will contain these Tasks

Headers

AuthorizationstringRequired

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

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

Request

The list of new Tasks to create
namestringRequired>=1 character
The common name of this Task.
descriptionstringOptional
A description of the work to be performed in this Task.
percentCompleteintegerOptional>=0<=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.

statusIdstringOptionalformat: "uuid"
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
plannedStartDatestringOptionalformat: "date"
The date when work on this Task is planned to begin.
plannedFinishDatestringOptionalformat: "date"
The date when work on this Task is expected to complete.
plannedDurationintegerOptional>=0<=6570000

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

plannedEffortintegerOptional>=0<=2147483647

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

plannedCostdoubleOptional>=0
The planned cost for this Task. Cannot be negative.
actualStartDatestringOptionalformat: "date"
The date when work on this Task actually started, if known.
actualCostdoubleOptional>=0
The actual cost of this Task to date, if known.
themestringOptional
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.
isLockedbooleanOptional

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.

isMilestonebooleanOptional
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.
parentIdstringOptionalformat: "uuid"
ParentId

Response

Success
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.
statusCodeobject or null
The HTTP code of the response.
datalist of objects or null
If the API call succeeded, this will contain the results.