Sign in

v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB
Tasks

Update a task

Updates a specified task.

put/tasks/{id}

Path parameters

idstring uuid required

Request body

matterIdstring nullable

Unique identifier of the matter associated to the task.

staffIdstring required

Unique identifier of the associated staff member creating or updating the task.

completedByStaffIdstring nullable

Unique identifier of the associated staff member completing the task.

assigneeIdsstring[] nullable

Unique identifier(s) of the associated staff member(s) assigned to the task.

subjectstring nullable

The subject - this should be a short description of the task.

notestring nullable

Notes on the task.

isCompletedboolean

True when the task is completed.

categoriesstring[] nullable

Categories for the task.

completedDatestring date-time nullable

Deprecated. Use CompletedDateOnly instead.

Completed date of the task in UTC. If not provided and IsCompleted is set to true, the current date will be used.

completedDateOnlystring date-time nullable

Completed date of the task. Takes precendence over CompletedDate if set. If not provided and IsCompleted is set to true, the current date will be used.

Any time/timezone information will be discarded and only the date portion will be considered.

dueDatestring date-time nullable

Deprecated. Use DueDateOnly instead.

Due date of the task in UTC.

dueDateOnlystring date-time nullable

Due date of the task. Takes precendence over DueDate if set.

Any time/timezone information will be discarded and only the date portion will be considered.

durationstring nullable

Duration of the task in ISO 8601 duration format.

Example request

{
  "matterId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "staffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "completedByStaffId": "750eb5c5-ac0b-7d11-4997-e0ce9d8896c8",
  "subject": "Review contract for John Smith",
  "note": "Contract needs to be reviewed and discussed with John",
  "completedDate": "2020-02-15T13:00:00Z",
  "completedDateOnly": "2020-02-15",
  "dueDate": "2020-02-15T13:00:00Z",
  "dueDateOnly": "2020-02-15",
  "duration": "PT4H33M"
}

Response

When request is accepted. Returns a hypermedia 'Link' object of the task to be updated.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable