API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · performance_review_templates

Performance Review Template Schema

Schema-ID
performance_review_template
Collection
performance_review_templates
Permissions
  • Lesenperformance_review_template_view
  • Anlegenperformance_review_template_create
  • Ändernperformance_review_template_edit
  • Löschenperformance_review_template_delete

Felder

Performance Review Template Schema

performance_review_templates4 Permissions

Schema for validating performance review template entities (Fragebogen-Vorlagen für Mitarbeitergespräche)

namestringerforderlich

Template name

1–200 Zeichen
descriptionstringoptional

Template description

max 2000 Zeichennullable
isActivebooleanoptional

Only active templates can be selected when creating new reviews

Default: true
isDefaultbooleanoptional

Default template used when none is explicitly selected

Default: false
versionintegererforderlich

Template version, bumped when a referenced template is edited

≥ 1Default: 1read-only
previousVersionIduuidoptional

Reference to the previous version when a new version is created

read-onlynullable
localestringoptional

Primary locale for prompts

Default: "de"
blocksobject[]erforderlich

Ordered list of question blocks. The last block is always the locked "Gesamtleistung" block (auto-enforced server-side).

min 1 Items
blockIduuiderforderlich

Stable block identifier

titlestringerforderlich

Block heading (Überschrift)

1–300 Zeichen
descriptionstringoptional

Optional helper text shown under the block heading

max 2000 Zeichennullable
sortOrderintegererforderlich

Sort order within the template

≥ 0
lockedbooleanoptional

Locked blocks (e.g. final "Gesamtleistung") cannot be edited or removed

Default: false
questionsobject[]erforderlich
min 1 Items
questionIdstringerforderlich

Stable question identifier. Reserved IDs: __overall_rating, __overall_comment

1–100 Zeichen
promptstringerforderlich

Question text shown to participants

1–2000 Zeichen
helpTextstringoptional

Optional helper / context text

max 2000 Zeichennullable
requiredbooleanerforderlich

If true, the question must be answered before submitting

Default: true
typestringerforderlich

Primary answer type (always equals types[0] when types is set; kept for backward compat). SKILL_INTEREST is reserved for the auto-injected __skill_interests question.

Werte
FREETEXTRATING_1_5YES_NOSINGLE_CHOICEMULTI_CHOICEDATENUMBERSKILL_INTEREST
typesstring[]optional

Ordered list of answer sub-types. When set, the question renders one input per sub-type and the answer value is stored as an object keyed by sub-type.

min 1 Itemsnullable
configobjectoptional

Type-specific configuration

nullable
maxCharsintegeroptional
1 – 50000nullable
minWordsintegeroptional
≥ 0nullable
maxWordsintegeroptional
≥ 1nullable
optionsstring[]optional
nullable
minSelectionsintegeroptional
≥ 1nullable
maxSelectionsintegeroptional
≥ 1nullable
minnumberoptional
nullable
maxnumberoptional
nullable
stepnumberoptional
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/performance_review_templates — Liste, paginiert + filterbar
  • GET /api/v1/performance_review_templates/<id> — Einzelne Entity
  • POST /api/v1/performance_review_templates — Anlegen
  • PATCH /api/v1/performance_review_templates/<id> — Teil-Update
  • DELETE /api/v1/performance_review_templates/<id> — Soft-Delete
  • GET /api/v1/performance_review_templates/<id>/timeline — Audit + Aktivitäten

Suche