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

Performance Review Schema

Schema-ID
performance_review
Collection
performance_reviews
Permissions
  • Lesenperformance_review_view
  • Anlegenperformance_review_create
  • Ändernperformance_review_edit
  • Löschenperformance_review_delete

Felder

Performance Review Schema

performance_reviews4 Permissions

Multi-participant performance review (Performance-Review) with templated questionnaire, meeting and Entwicklungsplan

employeeIduuiderforderlich

UUID of the employee profile being reviewed

typestringerforderlich

Review type

Werte
ANNUALPROBATION360_DEGREEAD_HOC
Default: "ANNUAL"
statusstringoptional

Workflow status

Werte
DRAFTCOLLECTINGAWAITING_MEETINGMEETING_SCHEDULEDAWAITING_AGREEMENT_APPROVALAGREEMENTS_ACTIVECOMPLETEDCANCELLED
Default: "DRAFT"
namestringoptional

Optional display name (defaults to template name + period if not set)

max 200 Zeichennullable
templateIduuiderforderlich

Reference to the performance_review_template used to seed this review

templateSnapshotobjectoptional

Frozen copy of the template at DRAFT→COLLECTING transition. Immutable after that point.

read-onlynullable
namestringoptional
versionintegeroptional
≥ 1read-only
localestringoptional
nullable
blocksobject[]optional
startDatedateerforderlich

Date the review becomes active (participants get notified)

deadlinedateerforderlich

Deadline by which all participants must have submitted their answers

participantsobject[]erforderlich

List of participants. Exactly one must have role EMPLOYEE; the rest are MANAGER (1..n) or OBSERVER (0..n, no questionnaire).

min 2 Items
userIduuiderforderlich
rolestringerforderlich
Werte
EMPLOYEEMANAGEROBSERVER
managerKindstringoptional

Optional hint about manager relationship type

Werte
DISCIPLINARYFUNCTIONALDOTTED
nullable
submittedAtdatetimeoptional
nullable
answersobjectoptional

Map of questionId → answer value (shape depends on question type)

Default: {}
overallRatingnumberoptional

Mandatory final-block rating (1–5)

1 – 5nullable
overallCommentstringoptional

Mandatory final-block free-text comment

max 5000 Zeichennullable
meetingobjectoptional
nullable
scheduledAtdatetimeoptional
nullable
durationMinintegeroptional
15 – 480Default: 60
locationstringoptional
max 500 Zeichennullable
proposedSlotsobject[]optional
Default: []
startdatetimeerforderlich
enddatetimeerforderlich
conflictsobject[]optional
Default: []
userIduuiderforderlich
statusstringerforderlich
Werte
FREEBUSYOFF_SHIFT
confirmedByuuidoptional
nullable
confirmedAtdatetimeoptional
nullable
calendarEventIduuidoptional

UUID of the linked calendar_events doc created on schedule-meeting. Bidirectional sync: edits to the event mirror back to this meeting block.

nullable
locationIduuidoptional

Optional UUID of the linked `locations` entity (building/room). When set, takes precedence over the free-text `location` field on display.

nullable
isTeamsMeetingbooleanoptional

When true, the linked calendar_events doc is marked as a Teams meeting and Outlook sync will auto-generate the onlineMeetingUrl.

Default: false
agreementsobject[]optional

Entwicklungsplan — list of action items / agreements captured during the meeting

Default: []
iduuiderforderlich
titlestringerforderlich
1–500 Zeichen
descriptionstringoptional
max 5000 Zeichennullable
ownerIduuidoptional
nullable
dueDatedateoptional
nullable
statusstringoptional
Werte
OPENIN_PROGRESSIN_REVIEWDONE
Default: "OPEN"
createTaskbooleanoptional

When true and an ownerId is set, a linked task is spawned on save and kept in bidirectional sync.

Default: false
linkedTaskIduuidoptional

UUID of the linked task (set by syncAgreementTasks after spawn). Cleared when the agreement opts out or is removed.

nullable
finalSummarystringoptional

Fazit — final summary written by the disciplinary manager / HR

max 10000 Zeichennullable
overallRatingnumberoptional

Aggregated overall rating (typically the manager overall, set on COMPLETED)

1 – 5nullable
pdfFileIduuidoptional

DMS file reference rendered after COMPLETED

read-onlynullable
completedAtdatetimeoptional
nullable
archivedAtdatetimeoptional

Set when the review transitions AGREEMENTS_ACTIVE → COMPLETED (manual archive or all agreements done).

read-onlynullable
agreementApprovalsobject[]optional

Per-EMPLOYEE/MANAGER approval of the development plan. Required for transition AWAITING_AGREEMENT_APPROVAL → AGREEMENTS_ACTIVE.

Default: []
userIduuiderforderlich
approvedAtdatetimeerforderlich
previousReviewIduuidoptional

Chain back to the previous performance_review for the same employee — surfaces old agreements in the new conversation.

nullable
cancelledAtdatetimeoptional
nullable
cancelReasonstringoptional
max 1000 Zeichennullable
notesstringoptional

Internal HR notes

max 5000 Zeichennullable

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

Suche