Entity · checklists

Checklist Schema

Schema-ID

checklist

Collection

checklists

Permissions

Lesenchecklist_view
Anlegenchecklist_create
Ändernchecklist_edit
Löschenchecklist_delete

Felder

Checklist Schema

checklists4 Permissions

Schema for validating checklist entities

titlestringerforderlich

Checklist title

1–200 Zeichen

descriptionstringoptional

Checklist description

max 2000 Zeichennullable

statusstringerforderlich

Checklist status

Werte

OPENIN_PROGRESSCOMPLETEDCANCELLED

templateIduuidoptional

Template UUID this checklist was created from

nullable

blocksCompletionbooleanoptional

Whether this checklist blocks the linked entity's completion until COMPLETED

Default: falsenullable

blocksExitFromStatusstringoptional

Status key whose exit this checklist blocks (e.g. IN_REVIEW_TECH). Absent = legacy completion gate.

nullable

linkedEntityTypestringerforderlich

Type of entity this checklist is linked to

1–64 Zeichen

linkedEntityIduuiderforderlich

UUID of the linked entity

progressnumberoptional

Progress percentage (0-100), computed from items

0 – 100Default: 0

itemsobject[]erforderlich

Default: []

itemIduuiderforderlich

Unique item identifier (UUID)

titlestringerforderlich

Item title

1–200 Zeichen

descriptionstringoptional

Item description

max 1000 Zeichennullable

knowledgeRefsobject[]optional

Per-step knowledge/KB links (guide/reference/training)

Default: []nullable

typestringerforderlich

Werte

kb_articlefileurlvideo

refIdstringerforderlich

max 1000 Zeichen

labelstringerforderlich

max 200 Zeichen

rolestringoptional

Werte

guidereferencetraining

Default: "reference"

statusstringerforderlich

Item status

Werte

PENDINGIN_PROGRESSPENDING_APPROVALDONESKIPPED

assigneeIduuidoptional

Assigned user UUID

nullable

dueDatedateoptional

Due date in YYYY-MM-DD format

nullable

dueOffsetobjectoptional

ADR 0831: relative due-date rule copied from the template item; `dueDate` is its resolved value.

Default: nullnullable

valueintegererforderlich

0 – 10000

unitstringerforderlich

Werte

mhdwmo

directionstringerforderlich

Werte

beforeafter

anchorstringerforderlich

Werte

startendcreatednow

anchorFieldstringoptional

Explicit dot path on the target entity that replaces the semantic anchor probing.

max 100 ZeichenPatternDefault: nullnullable

completedAtdatetimeoptional

Completion timestamp

nullable

timeBookedAtdatetimeoptional

Timestamp the item was reported in a task time booking (ADR 0307)

nullable

sortOrderintegererforderlich

Sort order within the checklist

≥ 0

requiredbooleanoptional

Whether this item must be completed before the linked task can be closed

Default: falsenullable

completedByuuidoptional

User UUID who completed this item

nullable

taskIduuidoptional

Optional linked Task. Completing/skipping the item flips the linked task to DONE/CANCELLED and vice versa.

nullable

parentItemIduuidoptional

UUID of the parent item. Null/missing for top-level items. Sub-items inherit visibility/cascade from their parent.

nullable

autoCompleteWhenSubsDonebooleanoptional

When true, the parent item is auto-set to DONE once all its sub-items reach DONE/SKIPPED. Only meaningful for items that have sub-items.

Default: truenullable

requireAllSubsDonebooleanoptional

When true, manually checking the parent fails (422) until every sub-item is DONE/SKIPPED. Enforced server-side as a synthetic guard.

Default: falsenullable

visibleIfobjectoptional

ADR 0511: condition under which this step is part of the run. Copied from the template at spawn.

Default: nullnullable

terminatesIfobjectoptional

ADR 0511: when this holds, the checklist completes early. Copied from the template at spawn.

Default: nullnullable

answerKeystringoptional

Stable key under which this step's answer is recorded in `answers`. Conditions reference this, never the item index.

max 40 ZeichenPatternDefault: nullnullable

inputobjectoptional

Typed answer step (ADR 0511). Renders an input instead of a checkbox; the value lands in `answers[answerKey]`.

Default: nullnullable

typestringerforderlich

Werte

textnumberdatebooleanselectentity_ref

entityTypestringoptional

max 64 Zeichennullable

optionsstring[]optional

Default: []nullable

requiredbooleanoptional

Default: false

unitstringoptional

max 20 Zeichennullable

minnumberoptional

nullable

maxnumberoptional

nullable

answerValueanyoptional

ADR 0511: raw value entered on a typed input step.

Default: null

hiddenbooleanoptional

ADR 0511: the step is not part of the run under the current answers. Excluded from progress, gates and watchers — never deleted.

Default: falsenullable

hiddenReasonstringoptional

Machine-readable cause, e.g. `answer:backup_status` or `parent:<itemId>`. Rendered as the "nicht mehr relevant" explanation.

max 128 Zeichennullable

injectedFromOptionIduuidoptional

Set on steps inserted by a choice option carrying `inject`.

nullable

injectedFromItemIduuidoptional

The choice item whose option inserted this step (for removal on change).

nullable

linkedTaskobjectoptional

nullable

enabledbooleanerforderlich

assigneeRuleobjectoptional

nullable

titleTemplatestringoptional

max 300 Zeichennullable

dueDaysintegeroptional

0 – 3650nullable

dueOffsetobjectoptional

ADR 0831: relative due-date rule of the linked task, copied from the template.

Default: nullnullable

valueintegererforderlich

0 – 10000

unitstringerforderlich

Werte

mhdwmo

directionstringerforderlich

Werte

beforeafter

anchorstringerforderlich

Werte

startendcreatednow

anchorFieldstringoptional

Explicit dot path on the target entity that replaces the semantic anchor probing.

max 100 ZeichenPatternDefault: nullnullable

prioritystringoptional

Werte

LOWNORMALHIGHCRITICAL

nullable

guardsobject[]optional

Guards that must pass before this item can be checked

Default: []nullable

typestringerforderlich

1–64 Zeichen

paramsobjectoptional

nullable

labelstringoptional

nullable

actionsobject[]optional

Actions that fire when this item is checked

Default: []nullable

typestringerforderlich

1–64 Zeichen

paramsobjectoptional

nullable

labelstringoptional

nullable

phasestringoptional

Werte

onEnteronExit

nullable

approvalobjectoptional

nullable

requiredbooleanerforderlich

approverTypestringoptional

Werte

roleuserorg_unit_manager

nullable

approverValuestringoptional

max 200 Zeichennullable

approvalRequestIduuidoptional

Open approval_request UUID while status=PENDING_APPROVAL

nullable

watchersobject[]optional

Reactive watchers that auto-complete this item when a data-provider condition matches

Default: []nullable

typestringerforderlich

1–64 Zeichen

paramsobjectoptional

nullable

labelstringoptional

nullable

onTruestringoptional

Werte

completeskip

nullable

onFalsestringoptional

Werte

noopuncheck

nullable

debounceSecondsnumberoptional

≥ 0nullable

notifyOnFirebooleanoptional

nullable

lastWatcherEvalobjectoptional

nullable

atdatetimeoptional

watcherTypestringoptional

resultstringoptional

Werte

matchedunmatchederror

inventoryHashstringoptional

nullable

errorMessagestringoptional

nullable

choiceobjectoptional

Scenario selector; each option carries its own completion actions

nullable

modestringoptional

single = exactly one option (radio); multi = several (checkboxes)

Werte

singlemulti

Default: "single"

requiredbooleanoptional

When true, at least one option must be selected before check-off

Default: falsenullable

optionsobject[]erforderlich

Default: []

optionIduuiderforderlich

labelstringerforderlich

1–200 Zeichen

sortOrderintegeroptional

≥ 0nullable

injectobjectoptional

ADR 0511: picking this option inserts the referenced template's steps into THIS checklist (one record, one progress, one completion gate) instead of spawning a separate one.

Default: nullnullable

checklistTemplateIduuiderforderlich

groupedbooleanoptional

Render the inserted steps as a collapsible block under a parent step.

Default: true

answerKeyPrefixstringoptional

Namespace for the inserted template's answer keys, so inserting the same template twice cannot overwrite answers.

max 40 ZeichenPatternnullable

actionsobject[]optional

Default: []nullable

typestringerforderlich

1–64 Zeichen

paramsobjectoptional

nullable

labelstringoptional

nullable

phasestringoptional

Werte

onEnteronExit

nullable

selectedOptionIdsuuid[]optional

Selected choice-option ids recorded on check-off

Default: []nullable

answersobjectoptional

ADR 0511: answers given so far, keyed by the steps' `answerKey`.

Default: {}nullable

answerHistoryobject[]optional

Audit trail of answer changes — the record of WHY steps appeared or disappeared.

Default: []nullable

keystringerforderlich

max 80 Zeichen

fromanyoptional

toanyoptional

atdatetimeerforderlich

byuuidoptional

nullable

terminationReasonstringoptional

Set when a step's `terminatesIf` completed the checklist early.

max 500 Zeichennullable

terminatedByItemIduuidoptional

The step whose `terminatesIf` fired.

nullable

tagsstring[]optional

Checklist tags

Default: []nullable

completedAtdatetimeoptional

Timestamp when the checklist transitioned to COMPLETED

nullable

cancelledAtdatetimeoptional

Timestamp when the checklist transitioned to CANCELLED

nullable

cancelReasonstringoptional

Required reason text set when the checklist is cancelled

max 500 Zeichennullable

reopenReasonstringoptional

Required reason text set when a COMPLETED checklist is re-opened

max 500 Zeichennullable

deadlinedatetimeoptional

Deadline by which the checklist should reach COMPLETED

nullable

responsibleUserIduuidoptional

User responsible for the whole checklist

nullable

responsiblePositionIduuidoptional

Position the responsible user was resolved from (informational)

nullable

deadlineEscalationobjectoptional

Who to notify when this checklist misses its deadline

nullable

notifyRecipientstringerforderlich

1–64 Zeichen

channelsstring[]optional

Default: []

deadlineEscalatedAtdatetimeoptional

Timestamp the deadline escalation notification was sent

nullable

stalledAtdatetimeoptional

Timestamp the checklist was flagged as STALLED

nullable

autoTransitionobjectoptional

Automatic workflow transition fired on the linked entity (ADR 0912)

read-onlynullable

entityTypestringoptional

entityIdstringoptional

fromstringoptional

tostringoptional

atdatetimeoptional

byUserIdstringoptional

nullable

undoRequestedAtdatetimeoptional

nullable

undoneAtdatetimeoptional

nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

GET /api/v1/checklists — Liste, paginiert + filterbar
GET /api/v1/checklists/<id> — Einzelne Entity
POST /api/v1/checklists — Anlegen
PATCH /api/v1/checklists/<id> — Teil-Update
DELETE /api/v1/checklists/<id> — Soft-Delete
GET /api/v1/checklists/<id>/timeline — Audit + Aktivitäten