Update a Task

Updates a task.

Path Params
string
required

Unique identifier of the task.

Query Params
boolean

Specify True to indicate task assignment to login user. Default is False.

string

Possible value is entity. When view entity is passed, the response body will include the entire updated data contract of the posted resource.

boolean

Indicates whether to include metadata in the response.

Body Params
string

Name of the task.

string

Description of the task.

string

Type of task.

customAttributes
array of objects

Custom Attributes of the task.

customAttributes
associations
array of objects
associations
boolean

Indicates if the task is required to mark the parent as complete.

string

Status of the task. Possible values are:

  • NOT_STARTED
  • IN_PROGRESS
  • COMPLETED
string

Resolution of the task.

string

Resolution comment of the task.

integer

Priority of the task.

string

Rank of the task to indicate the sort order. Items with lower rank are presented items with higher rank.

tags
array of strings

Tags on the task.

tags
metadata
object

Task related information.

boolean

Flag to indicate whether the task will be marked complete if all required sub entities under the task are completed.

string

Unique identifier of the task group, if present.

assignee
object

Primary assignee of the task.

workEntity
object

Work Entity of the task.

string

Due date of the task.

string

UTC Datetime on which task is started.

string

UTC Datetime on which task is completed.

integer

Duration for task to be completed.

string

Duration format for task to be completed. Possible values are:

  • Minute
  • Hour
  • Day
    For example, ['Minute', 'Hour', 'Day']
Headers
string
required

Bearer token

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Language
URL
LoadingLoading…
Response
Choose an example:
application/json