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

Coverage Demand Schema

Schema-ID
coverage_demand
Collection
coverage_demands
Permissions
  • Lesencoverage_demand_view
  • Anlegencoverage_demand_create
  • Änderncoverage_demand_edit
  • Löschencoverage_demand_delete

Felder

Coverage Demand Schema

coverage_demands4 Permissions

A continuous staffing requirement for a coverage unit (e.g. a vehicle "RTW-1", a workstation, a process). Defines which roles must be covered over which time window with which minimum headcount, and which shift-blocks the planner is allowed to compose the coverage from. Replaces the former `coverageGroup` flag and `positionSlots[]` array on shift-template — Bedarf and Schicht-Baustein are now orthogonal.

namestringerforderlich

Coverage unit name (e.g. "RTW-1", "KTW Köln-Süd", "Helpdesk Tier 1")

1–200 Zeichen
shortNamestringoptional

Short display label (e.g. "RTW-1")

max 20 Zeichennullable
descriptionstringoptional
max 2000 Zeichennullable
colorstringoptional

Optional UI hint color (used by planner grid and assignment cells)

Patternnullable
isActivebooleanoptional

Whether this demand is currently being planned

Default: true
assetIduuidoptional

Optional reference to a physical asset (vehicle, workstation, etc.)

nullable
orgUnitIduuidoptional

Optional reference to the org unit responsible for this demand

nullable
crewTemplateIduuidoptional

Crew template the roles[] were derived from (purely informational — once roles are set, the demand owns them and the crew template can change without affecting this demand).

nullable
coverageWindowobjecterforderlich

When this demand must be covered.

modestringerforderlich

"ALWAYS" = continuous 24/7 coverage. "WEEKLY" = covered during the specified weekly slots only (e.g. KTW Mo–Fr 06:00–14:00).

Werte
ALWAYSWEEKLY
weeklySlotsobject[]optional

Required only when mode = WEEKLY. Each slot defines a contiguous window.

Default: []
daysOfWeeknumber[]erforderlich

Weekdays the slot applies to. 0 = Sunday … 6 = Saturday.

min 1 Items
startTimestringerforderlich
Pattern
endTimestringerforderlich

If endTime <= startTime, the slot wraps to the next day.

Pattern
excludedDatesdate[]optional

Specific dates with no coverage demand (holidays, planned downtime).

Default: []
allowedBlockIdsuuid[]erforderlich

IDs of shift-blocks the planner may use to staff this demand. RTW-1 might list [24h, 12h-Tag, 12h-Nacht]; RTW-3 only [24h]; KTW only [8h-Früh].

min 1 Items
rolesobject[]erforderlich

Roles that must be covered continuously inside coverageWindow.

min 1 Items
slotIdstringerforderlich

Stable identifier of this role within the demand (used by assignments).

max 100 Zeichen
namestringerforderlich
max 200 Zeichen
minHeadcountnumbererforderlich
≥ 0Default: 1
maxHeadcountnumberoptional
≥ 1nullable
isMandatorybooleanoptional

If true, demand is infeasible without this role filled.

Default: true
requiredSkillsobject[]optional
Default: []
skillIduuiderforderlich
minimumLevelstringoptional
Werte
BEGINNERINTERMEDIATEADVANCEDEXPERTnull
nullable
requiredbooleanoptional
Default: true
allowedBlockIdsOverrideuuid[]optional

Optional per-role override of allowedBlockIds (e.g. "Fahrer immer 24h, NotSan frei mischbar"). When null, the demand-level allowedBlockIds apply.

nullable
notestringoptional
max 500 Zeichennullable
validFromdateoptional

First date this demand is active (inclusive). Null = no lower bound.

nullable
validTodateoptional

Last date this demand is active (inclusive). Null = open-ended.

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

Suche