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

Shift Block Schema

Schema-ID
shift_block
Collection
shift_blocks
Permissions
  • Lesenshift_block_view
  • Anlegenshift_block_create
  • Ändernshift_block_edit
  • Löschenshift_block_delete

Felder

Shift Block Schema

shift_blocks4 Permissions

A reusable time block ("Schicht-Baustein") an employee can occupy — e.g. "24h", "Tag-12h", "Nacht-12h", "8h-Früh". Pure time + ArbZG metadata, no role/headcount/coverage information (those live in coverage-demand). Replaces the former shift-template entity.

namestringerforderlich

Block name (e.g. "24h", "Tag-12h", "Nacht-12h", "8h-Früh")

1–200 Zeichen
shortNamestringoptional

Short display label (e.g. "24h", "T12", "N12", "F8")

max 10 Zeichennullable
startTimestringerforderlich

Start time in HH:mm format (24h clock)

Pattern
endTimestringerforderlich

End time in HH:mm format. If endTime <= startTime the block wraps to the next day (e.g. 18:00 → 06:00 for a Nacht-12h block).

Pattern
breakMinutesnumberoptional

Break duration in minutes (unpaid)

0 – 480Default: 30
colorstringerforderlich

Display color as hex

Pattern
isActivebooleanoptional

Whether this block is currently selectable

Default: true
notesstringoptional
max 2000 Zeichennullable
shiftTypestringoptional

Type of shift determining ArbZG treatment

Werte
REGULARBEREITSCHAFTRUFBEREITSCHAFTNOTDIENSTSPLITSPRINGEROVERLAP
Default: "REGULAR"
attendanceTimeRationumberoptional

Bereitschaftsdienst: ratio of attendance time counted as full working time (e.g. 0.25). For 24h-Schichten typically ~0.5–0.7.

0 – 1nullable
reactionTimeMinutesnumberoptional

Rufbereitschaft: required response time in minutes

≥ 0nullable
minimumRestAfterMinutesnumberoptional

Required rest after this block in minutes (overrides ArbZG § 5 default of 11h if higher)

≥ 0nullable

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

Suche