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

Shift Preference Schema

Schema-ID
shift_preference
Collection
shift_preferences
Permissions
  • Lesenshift_preference_view
  • Anlegenshift_preference_create
  • Ändernshift_preference_edit
  • Löschenshift_preference_delete

Felder

Shift Preference Schema

shift_preferences4 Permissions

Schema for employee shift preferences (Wunschzettel)

schedulePeriodIduuiderforderlich
employeeIduuiderforderlich
userIduuiderforderlich
statusstringoptional
Werte
DRAFTSUBMITTEDLOCKED
Default: "DRAFT"
submittedByuuidoptional
nullable
llmParseConfirmedByuuidoptional
nullable
availabilityobject[]optional
Default: []
startDatedateerforderlich
endDatedateerforderlich
typestringerforderlich
Werte
AVAILABLEUNAVAILABLEPREFERREDAVOID
notestringoptional
max 500 Zeichennullable
shiftPreferencesobject[]optional
Default: []
shiftBlockIduuiderforderlich
preferencestringerforderlich
Werte
LOVEPREFERNEUTRALAVOIDNEVER
weightnumberoptional

Importance weight

1 – 5Default: 3
colleaguePreferencesobject[]optional

References target employees by employeeId (not userId) so colleagues without a user account can be picked.

Default: []
employeeIduuiderforderlich
typestringerforderlich
Werte
PREFER_WITHPREFER_NOT_WITH
notestringoptional
max 500 Zeichennullable
timePreferencesobjectoptional
nullable
preferMorningsbooleanoptional
Default: false
preferEveningsbooleanoptional
Default: false
preferNightsbooleanoptional
Default: false
preferWeekendsbooleanoptional
Default: false
avoidWeekendsbooleanoptional
Default: false
maxShiftsPerWeeknumberoptional
0 – 7nullable
preferBlocksbooleanoptional

Prefer consecutive shift blocks

Default: false
avoidShortChangeoversbooleanoptional

Avoid late-then-early sequences beyond the legal ArbZG §5 minimum

Default: false
tradeoffsobject[]optional

Conditional wishes (if-then tradeoffs)

max 10 ItemsDefault: []
ifConditionstringerforderlich
max 500 Zeichen
thenAcceptstringerforderlich
max 500 Zeichen
customWishesstringoptional

Free-text wishes, parsed by LLM

max 3000 Zeichennullable
preferenceWeightsobjectoptional

Relative importance of each preference dimension (1-10)

nullable
availabilitynumberoptional
1 – 10Default: 5
shiftTypenumberoptional
1 – 10Default: 5
colleaguenumberoptional
1 – 10Default: 3
timenumberoptional
1 – 10Default: 4
submittedAtdatetimeoptional
nullable
lockedAtdatetimeoptional
read-onlynullable
lockedByuuidoptional
read-onlynullable
llmParseResultobjectoptional

Parsed structured constraints from customWishes

nullable
llmParseConfirmedAtdatetimeoptional

When employee confirmed the LLM parse result

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

Suche