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

Objective (OKR) Schema

Schema-ID
objective
Collection
objectives
Permissions
  • Lesenobjective_view
  • Anlegenobjective_create
  • Ändernobjective_edit
  • Löschenobjective_delete

Felder

Objective (OKR) Schema

objectives4 Permissions

Schema for validating objective entities (Zielvereinbarungen / OKRs)

employeeIduuiderforderlich

UUID of the employee profile

reviewIduuidoptional

Optional link to a performance review

nullable
titlestringerforderlich

Objective title (e.g. "Kundenzufriedenheit steigern")

1–500 Zeichen
descriptionstringoptional

Detailed objective description

max 5000 Zeichennullable
periodStartdateerforderlich

Period start

periodEnddateerforderlich

Period end

statusstringoptional
Werte
DRAFTACTIVECOMPLETEDCANCELLED
Default: "DRAFT"
keyResultsobject[]optional

Key results for this objective

Default: []
krIduuidoptional
titlestringerforderlich

Key result title

1–500 Zeichen
unitstringoptional

Unit of measurement (e.g. "%", "Stunden", "NPS")

max 50 Zeichennullable
targetValuenumbererforderlich

Target value to achieve

currentValuenumberoptional

Current progress value

Default: 0
progressnumberoptional

Progress percentage (0-100)

0 – 100Default: 0
overallProgressnumberoptional

Overall objective progress

0 – 100Default: 0
notesstringoptional
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/objectives — Liste, paginiert + filterbar
  • GET /api/v1/objectives/<id> — Einzelne Entity
  • POST /api/v1/objectives — Anlegen
  • PATCH /api/v1/objectives/<id> — Teil-Update
  • DELETE /api/v1/objectives/<id> — Soft-Delete
  • GET /api/v1/objectives/<id>/timeline — Audit + Aktivitäten

Suche