Entity · checklist_templates

Checklist Template Schema

Schema-ID

checklist_template

Collection

checklist_templates

Permissions

Lesenchecklist_template_view
Anlegenchecklist_template_create
Ändernchecklist_template_edit
Löschenchecklist_template_delete

Felder

Checklist Template Schema

checklist_templates4 Permissions

Schema for validating checklist template entities

titlestringerforderlich

Template title

1–200 Zeichen

descriptionstringoptional

Template description

max 2000 Zeichennullable

categorystringerforderlich

Template category (validated server-side against CHECKLIST_CATEGORIES)

1–64 Zeichen

targetEntityTypestringerforderlich

Target entity type (validated server-side against the tenant allowlist)

1–64 Zeichen

autoCreatebooleanoptional

Whether to automatically create checklists from this template

Default: false

blocksCompletionbooleanoptional

Whether checklists spawned from this template block the linked entity's completion until COMPLETED

Default: falsenullable

blocksExitFromStatusstringoptional

Status key whose exit spawned checklists block (e.g. IN_REVIEW_TECH). Absent = legacy completion gate.

nullable

itemsobject[]erforderlich

Default: []

itemIduuidoptional

Stable identifier within the template. Used to anchor parentItemId refs.

nullable

titlestringerforderlich

Item title

1–200 Zeichen

descriptionstringoptional

Item description

max 1000 Zeichennullable

sortOrderintegererforderlich

Sort order within the template

≥ 0

defaultAssigneeRolestringoptional

Default assignee role slug

max 100 Zeichennullable

parentItemIduuidoptional

References another template item by itemId to mark this as a sub-item.

nullable

autoCompleteWhenSubsDonebooleanoptional

Inherited by spawned checklist items; auto-complete parent when subs done.

Default: truenullable

requireAllSubsDonebooleanoptional

Inherited by spawned checklist items; require subs done before parent DONE.

Default: falsenullable

visibleIfobjectoptional

ADR 0511: the step is only part of the run when this condition holds. Absent/null = always visible. May only reference answers from EARLIER steps.

Default: nullnullable

terminatesIfobjectoptional

ADR 0511: when this holds on a visible step, the checklist completes early with `terminationReason` and remaining open steps are SKIPPED.

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

dueOffsetobjectoptional

ADR 0831: due date of this step relative to a date of the linked entity (start/end/created) or to the spawn instant (now). Resolved into items[].dueDate when the checklist is spawned.

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

linkedTaskobjectoptional

nullable

enabledbooleanerforderlich

assigneeRuleobjectoptional

nullable

titleTemplatestringoptional

max 300 Zeichennullable

dueDaysintegeroptional

0 – 3650nullable

dueOffsetobjectoptional

ADR 0831: due date of the linked task relative to a date of the linked entity. Takes precedence over `dueDays`.

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

approvalobjectoptional

nullable

requiredbooleanerforderlich

approverTypestringoptional

Werte

roleuserorg_unit_manager

nullable

approverValuestringoptional

max 200 Zeichennullable

guardsobject[]optional

Guards inherited by checklist items created from this template

Default: []nullable

typestringerforderlich

1–64 Zeichen

paramsobjectoptional

nullable

labelstringoptional

nullable

actionsobject[]optional

Actions inherited by checklist items created from this template

Default: []nullable

typestringerforderlich

1–64 Zeichen

paramsobjectoptional

nullable

labelstringoptional

nullable

phasestringoptional

Werte

onEnteronExit

nullable

watchersobject[]optional

Reactive watchers inherited by checklist items created from this template

Default: []nullable

typestringerforderlich

1–64 Zeichen

paramsobjectoptional

nullable

labelstringoptional

nullable

onTruestringoptional

Werte

completeskip

nullable

onFalsestringoptional

Werte

noopuncheck

nullable

debounceSecondsnumberoptional

≥ 0nullable

notifyOnFirebooleanoptional

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

tagsstring[]optional

Template tags

Default: []nullable

deadlineOffsetobjectoptional

Relative deadline offset. Without direction/anchor: spawn instant + offset. With them: resolved against the linked entity (ADR 0831).

nullable

valuenumbererforderlich

≥ 0

unitstringerforderlich

Werte

mhdwmo

directionstringoptional

Werte

beforeafternull

nullable

anchorstringoptional

Werte

startendcreatednownull

nullable

anchorFieldstringoptional

max 100 ZeichenPatternnullable

responsibleUserIduuidoptional

Responsible person (mutually exclusive with responsiblePositionId)

nullable

responsiblePositionIduuidoptional

Responsible position; resolved to its primary holder at spawn time

nullable

responsibleSourcestringoptional

Dynamic responsible resolution at spawn time (e.g. the linked entity's team lead)

Werte

org_unit_managernull

nullable

autoCreateTriggerobjectoptional

Auto-create the checklist when the target entity matches this trigger

nullable

eventsstring[]erforderlich

min 1 Items

conditionsobject[]optional

Default: []

fieldstringerforderlich

1–128 Zeichen

operatorstringerforderlich

Werte

eqneinchangedchanged_to

valueanyoptional

spawnOnobjectoptional

nullable

sourceEntityTypestringerforderlich

1–64 Zeichen

sourceFieldstringerforderlich

1–128 Zeichen

deadlineEscalationobjectoptional

Who to notify when the spawned checklist misses its deadline

nullable

notifyRecipientstringerforderlich

1–64 Zeichen

channelsstring[]optional

Default: []

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