Create Task Template

post

https://api.apicbase.com/api/v2/compliance/tasks/

Creates a new compliance task template.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Creates a compliance task template and schedules it in every outlet of outlets. Library users can schedule the
task in any outlet of the library; outlet users only in the outlets they are connected to, and need the permission
to manage compliance tasks in each of them.

type cannot be changed once the template is created.

recurrence is validated against its own frequency: a key that does not apply to the frequency is rejected
rather than ignored.

The possible values of type, the keys type_specific holds per type, and the recurrence fields each frequency
accepts are listed on the
Reference Values page.

Body Params

name

string

required

length ≤ 150

The name of the task template.

description

string

The description of the task template. Defaults to an empty string.

type

string

enum

required

The template type slug. It decides which keys type_specific holds. See Template types. The set is open: new values may be added without it counting as a breaking change.

outlets

array of strings

required

length ≥ 1

The IDs of the outlets to schedule the task in. An outlet may not be listed twice. Outlet users can only list outlets they are connected to; the outlets of the template they have no access to are kept as they are.

outlets*

assignee

string | null

The ID of the user the task is assigned to. Only accepted when the task is scheduled in a single outlet — a template spanning several outlets cannot carry an assignee. An outlet user has to have access to that outlet.

prevent_early_execution

boolean

Whether the task cannot be completed before its scheduled day. Defaults to true.

active

boolean

Whether the schedule is enabled. Defaults to true.

recurrence

object

required

The schedule of the template. It is written as a whole: a request that touches it carries every key its frequency requires.

type_specific

object

The type-dependent definitions of the template. Which keys apply — and which of them are required — is decided by type. See Template types.

Responses

Language

Credentials

OAuth2

Loading…

Response

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

application/json

201201

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

403Forbidden — the Tasks module is off, or the user cannot manage compliance tasks.