Mark Task Occurrence Not Applicable

post

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

Marks a task occurrence as not applicable.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Requires permission to perform the task in the occurrence's outlet.

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

The call is also refused before the occurrence's day when the template has prevent_early_execution set. Unlike completion, the values the task type asks for are not checked: there is nothing to measure.

Path Params

occurrence_id

string

required

The opaque occurrence token from the calendar endpoint.

Body Params

remarks

string

Why the task could not be performed. Required: an occurrence carrying no remarks at all is refused.

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

Values entered before the occurrence turned out not to be performable. Written as sent, but they do not produce a result. 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.