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

Schedule Period Schema

Schema-ID
schedule_period
Collection
schedule_periods
Permissions
  • Lesenschedule_period_view
  • Anlegenschedule_period_create
  • Ändernschedule_period_edit
  • Löschenschedule_period_delete

Felder

Schedule Period Schema

schedule_periods4 Permissions

Schema for validating schedule period entities (Planungsperioden)

namestringerforderlich

Period name, e.g. "März 2026 – Pflege A"

1–200 Zeichen
orgUnitIduuidoptional

Organizational unit UUID. Null/omitted = tenant-wide period.

nullable
startDatedateerforderlich

Period start date (YYYY-MM-DD)

endDatedateerforderlich

Period end date (YYYY-MM-DD)

preferenceDeadlinedatetimeoptional

Deadline for employee preference submission

nullable
publicationDeadlinedatetimeoptional

Target date for schedule publication

nullable
federalStatestringoptional

German federal state for holiday calendar. Deprecated: new periods derive the region from org_unit.holidayRegion (with fallback to tenant.settings.defaultHolidayRegion). Retained for legacy records.

Werte
BBBEBWBYHBHEHHMVNINWRPSHSLSNSTTHnull
nullable
statusstringoptional
Werte
DRAFTPREFERENCE_COLLECTIONGENERATINGREVIEWBETRIEBSRAT_REVIEWPUBLISHEDARCHIVED
Default: "DRAFT"
betriebsratReviewRequiredbooleanoptional
Default: false
betriebsratReviewNotestringoptional
max 5000 Zeichennullable
publishedAtdatetimeoptional
nullable
publishedByuuidoptional
nullable
generationJobIdstringoptional
max 200 Zeichennullable
generationStartedAtdatetimeoptional
nullable
generationFinishedAtdatetimeoptional
nullable
generationErrorstringoptional
max 5000 Zeichennullable
qualityScorenumberoptional
0 – 100nullable
qualityReportobjectoptional

Solver + Claude quality evaluation result (merged)

nullable
isFeasiblebooleanoptional

Whether the solver found a feasible plan covering all mandatory slots

nullable
solveTimeMsnumberoptional
≥ 0nullable
objectiveValuenumberoptional
nullable
neverViolationsobject[]optional

Assignments that violated employee NEVER preferences

nullable
unfilledSlotsobject[]optional

Mandatory coverage slots the solver could not fill, with reason

nullable
coverageShiftTemplateIdsuuid[]optional

Shift templates that must be covered in this period

Default: []
constraintSetIduuidoptional

Tarifvertrag constraint set

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

Suche