Complete Task Occurrence

Completes a task occurrence.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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

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

Completion is refused while any of the following holds:

  • a value the task type asks for is still missing
  • a custom field the library marks as required is not filled in
  • the values make the result nok and remarks is empty
  • the day has not come yet and the template has prevent_early_execution set

mitigation_skipped is only accepted when the occurrence's mitigation_policy is 1 (optional); with any other policy, skipping the corrective action is not a choice the caller has.

completion.result is recalculated from the values in force on every call, while completion.submitted_at keeps the moment the occurrence was first completed.

Path Params
string
required

The opaque occurrence token from the calendar endpoint.

Body Params
string

The remarks entered on the occurrence.

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. The result is recalculated from the values in force after the merge. 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.

boolean

True records that the corrective action for a failed (nok) check was deliberately skipped. Only accepted when the occurrence's mitigation_policy is 1 (optional). See Mitigation policy.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json