Save Task Occurrence

patch

https://api.apicbase.com/api/v2/compliance/tasks/occurrences/{occurrence_id}/

Edits an existing task occurrence without resolving it.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Requires permission to perform the task in the occurrence's outlet. Editing an occurrence that is already completed or marked not applicable requires the permission to edit completed tasks instead.

For a full explanation of task occurrences, see Recording Task Occurrences.

Attachments are never touched here. They have their own endpoints.

Path Params

occurrence_id

string

required

The opaque occurrence token from the calendar endpoint.

Body Params

remarks

string

The remarks entered on the occurrence.

done_by

string | null

The ID of the user who performed the task, reported back as completion.done_by. Has to be a user of the library with access to the occurrence's outlet. Left out, it is not changed.

type_specific

object

The values entered for the occurrence's own task type, one key per type. Refused on an occurrence that is already completed or marked not applicable. See Template types.

custom_fields

object

The values of the library's task custom fields, keyed by field slug. A slug the library does not define is rejected; a choices field takes one of its configured options and a multi field a list of them.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400Bad request — the payload failed validation, or a save rule refused it.

403Forbidden — the Tasks module is off, or the user lacks the permission needed.

404Occurrence not found.

409Conflict — another request is writing this day of the task.