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

On-Call Schedule Schema

Schema-ID
on_call_schedule
Collection
on_call_schedules
Permissions
  • Lesenescalation_schedule_view
  • Anlegenescalation_schedule_manage
  • Ändernescalation_schedule_manage
  • Löschenescalation_schedule_manage

Felder

On-Call Schedule Schema

on_call_schedules4 Permissions

Schema for validating on-call schedule entities with rotation layers

namestringerforderlich

Schedule name

1–200 Zeichen
descriptionstringoptional

Schedule description

nullable
teamIduuidoptional

Linked team UUID

nullable
escalationPolicyIduuidoptional

Linked escalation policy UUID

nullable
rotationobjecterforderlich

Rotation configuration

typestringerforderlich

Rotation frequency

Werte
WEEKLYBIWEEKLYMONTHLYCUSTOM
startDatedateerforderlich

Rotation start date (ISO 8601 date)

handoffTimestringerforderlich

Time of day for handoff (HH:mm)

Pattern
handoffDayintegeroptional

Day of week for handoff (0=Sun, 6=Sat)

0 – 6nullable
layersobject[]erforderlich

On-call layers with escalation levels

_idstringoptional

UUIDv7 layer ID

read-only
namestringerforderlich

Layer name

levelintegererforderlich

Escalation level (1 = primary)

≥ 1
participantsobject[]erforderlich

Participants in rotation order

userIduuiderforderlich

Participant user UUID

sortOrderintegererforderlich

Rotation order within the layer

businessHoursProfileIduuidoptional

Business hours profile UUID for coverage windows

nullable
inboundPhoneNumberstringoptional

Inbound phone number in E.164 format

nullable
afterHoursRouteTypestringoptional

Routing behaviour outside business hours

Werte
ON_CALLVOICEMAILIVR
nullable
isActivebooleanerforderlich

Whether this schedule is active

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

Suche