API Reference

Create checklist instances from a template

post

Instances one or more checklists from a checklist template definition. A checklist instance is created for each location x workstation combination resolved from the template and the (optionally filtered) location/procedure lists.

Optionally, measurement values can be pre-filled on procedures and webhook callbacks can be registered to fire when the checklists are closed.

All events (instancing, measurements, webhooks) are persisted in a single transactional batch — if any measurement fails, nothing is persisted.

Authorizations

apiKey

X-Api-KeystringRequired

Tenant-level or per-key API key. Per-key API keys are at least 40 characters and are verified via BCrypt. Tenant-level keys are checked against a static configuration list.

Body

application/json

titleone ofOptional

Custom title for the instanced checklists. If omitted, the checklist template's name is used. Accepts both strings and numbers (numbers are cast to string).

Example: Shift A Morning Check

stringOptional

or

integer · uint32Optional

checklistTemplateIdone ofOptional

Identifies the checklist template to instance. Accepts either a UUID string or a numeric checklist definition number.

string · uuidOptionalExample: a1b2c3d4-e5f6-7890-abcd-ef1234567890

or

integer · uint32OptionalExample: 42

locationIdsstring · uuid[]Optional

UUIDs of locations to instance. If omitted, all locations defined on the checklist template are used.

Example: ["11111111-1111-1111-1111-111111111111"]

procedureIdsstring · uuid[]Optional

UUIDs of procedure templates to include. If omitted, all procedures from the template's ordered master list are used.

Example: ["22222222-2222-2222-2222-222222222222"]

earliestStartAtstring · date-timeOptional

RFC3339 timestamp for the checklist's earliest start time. If omitted, defaults to the server's current time in the tenant's timezone.

Example: 2024-06-01T06:00:00+02:00

closeAtstring · date-timeOptional

RFC3339 timestamp for the checklist's auto-close time. Optional.

Example: 2024-06-01T14:00:00+02:00

Responses

201

One or more checklists were successfully created.

application/json

totalCountintegerOptional

Number of checklist instances created.

Example: 2

checklist.startedstring · uuid[]Optional

UUIDs of the created checklist instances.

Example: ["aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee","ffffffff-1111-2222-3333-444444444444"]

204

Request was valid but no checklists were created (e.g. no matching location/procedure combinations resolved from the template).

400

Validation error. Either the JSON could not be parsed, request parameters failed validation, the checklist template was not found, or one or more measurements could not be added.

application/json

401

Authentication failed.

application/problem+json

post

/checklists

HTTPcURLJavaScriptPython

POST /api/checklists HTTP/1.1
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "checklistTemplateId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Minimal request — instance all locations/proceduresReference template by numeric IDFull request with measurements and callbacks

{
  "totalCount": 2,
  "checklist.started": [
    "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "ffffffff-1111-2222-3333-444444444444"
  ]
}