API ReferenceTask

Update Task

Update an existing Task and replace the values of fields specified. 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. Multiple users can be working on data at the same time. When you call an API to update an object, this call is converted into a Changeset that is then applied sequentially. You can use RetrieveChangeset to see the status of an individual Changeset. Known Issues: This API returns an error if your Update call includes too many changes in a single API call. Please restrict usage to one change per API request. This API will be deprecated and replaced with an improved API call in a future release.

Authentication

AuthorizationBearer

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

Path parameters

taskIdstringRequiredformat: "uuid"
The unique identifier of the Task to update

Headers

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

Request

All non-null fields in this object will replace existing data in the Task

namestring or nullOptional
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 TaskStatus assigned to this Task.
priorityIdinteger or nullOptional
The unique identifier of the TaskPriority
plannedStartDatestring or nullOptionalformat: "date"

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.

plannedFinishDatestring or nullOptionalformat: "date"

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.

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"

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.

actualFinishDatestring or nullOptionalformat: "date"

If set, this is the actual date when work was completed 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.

actualDurationinteger or nullOptional0-6570000

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

actualCostdouble or nullOptional>=0
If set, this represents the actual tracked cost for this Task.
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.

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