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.
Fields
| Field | Description |
|---|---|
| id uuid required | The unique identifier of this Task. |
| projectId uuid required | The unique identifier of the Project to which this Task belongs. |
| shortId string optional | A short ID that can be used to refer to this Task. This short ID is guaranteed to be unique within your Workspace. |
| name string optional | The common name of this Task. |
| description string optional | A description of the work to be performed in this Task. |
| plannedStartDate date-time optional | The date when work on this Task is planned to begin. This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone. For reporting purposes, this date is calculated against the official time zone of the Workspace. For example: A Task has a planned completion date of July 5, 2023 in a Workspace that has a time zone of US Pacific Time (GMT-7 or GMT-8, depending on daylight savings time). This project is considered overdue on 12:01 AM July 6th 2023 in US Pacific time. |
| plannedFinishDate date-time optional | The date when work on this Task is expected to complete. This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone. For reporting purposes, this date is calculated against the official time zone of the Workspace. For example: A Task has a planned completion date of July 5, 2023 in a Workspace that has a time zone of US Pacific Time (GMT-7 or GMT-8, depending on daylight savings time). This project is considered overdue on 12:01 AM July 6th 2023 in US Pacific time. |
| actualStartDate date-time optional | If set, this is the actual date when work began on the Task. This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone. For reporting purposes, this date is calculated against the official time zone of the Workspace. For example: A Task has a planned completion date of July 5, 2023 in a Workspace that has a time zone of US Pacific Time (GMT-7 or GMT-8, depending on daylight savings time). This project is considered overdue on 12:01 AM July 6th 2023 in US Pacific time. |
| actualFinishDate date-time optional | If set, this is the actual date when work was completed on this Task. This value contains only the date in year-month-day format. For display, this date will always be shown as this same year-month-day regardless of time zone. For reporting purposes, this date is calculated against the official time zone of the Workspace. For example: A Task has a planned completion date of July 5, 2023 in a Workspace that has a time zone of US Pacific Time (GMT-7 or GMT-8, depending on daylight savings time). This project is considered overdue on 12:01 AM July 6th 2023 in US Pacific time. |
| modifyDate date-time required | The timestamp in UTC when this Task was most recently modified. |
| createDate date-time required | The timestamp in UTC when this Task was created. |
| percentComplete int32 required | 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. |
| isSummary boolean required | True if this Task is the parent of multiple Tasks underneath it. A parent Task is a "rolled-up" view of multiple children that allows you to view a section of work at a glance. You can create a summary Task in the Gantt chart view of the application by adding child tasks underneath a parent Task. |
| priorityId int32 required | Return the priority of a task |
| wbs string optional | The WBS (Work Breakdown Structure) number for this task within the Gantt chart hierarchy. See What Is a Work Breakdown Structure (WBS)? on Project Manager for more information. The WBS number is an outline number in the form #.#.#.#which indicates how tasks are organized and sorted. The WBS value is only available to users at certain edition levels. This value can only be changed if you are a Project Editor. |
| color string optional | Task Color as set in the Gantt |
| actualCost double optional | The actual cost of this Task to date, if known. |
| plannedCost double optional | The planned cost for this Task. Cannot be negative. |