Task

Update Task

PUT

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.

Path parameters

taskIdstringRequired
The unique identifier of the Task to update

Request

This endpoint expects an object.
name
stringOptional
The common name of this Task.
description
stringOptional
A description of the work to be performed in this Task.
percentComplete
integerOptional
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.
statusId
stringOptional
The TaskStatus assigned to this Task.
priorityId
integerOptional
The unique identifier of the TaskPriority
plannedStartDate
stringOptional
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
stringOptional
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.
plannedDuration
integerOptional
The planned duration (in minutes) for this Task. Cannot be negative.
plannedEffort
integerOptional
The planned effort (in minutes) for this Task. Cannot be negative.
plannedCost
doubleOptional
The planned cost for this Task. Cannot be negative.
actualStartDate
stringOptional
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.
actualCost
doubleOptional
If set, this represents the actual tracked cost for this Task.
theme
stringOptional
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.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
objectOptional
Returns the id of a specific ChangeSet
PUT
1curl -X PUT /api/data/tasks/taskId \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200
Updated
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue",
12 "data": {
13 "changeSetId": "changeSetId",
14 "id": "id"
15 }
16}