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

Vacation Handover Schema

Schema-ID
vacation_handover
Collection
vacation_handovers
Permissions
  • Lesenvacation_handover_view
  • Anlegenvacation_handover_create
  • Ändernvacation_handover_edit
  • Löschenvacation_handover_delete

Felder

Vacation Handover Schema

vacation_handovers4 Permissions

Schema for validating vacation handover entities (Urlaubsübergaben)

subjectUserIduuiderforderlich

User UUID of the absent person whose tickets/tasks are handed over.

subjectUserNamestringoptional

Denormalized display name of the subject, for the handover list.

max 200 Zeichennullable
periodFromdateerforderlich

First day of the absence (ISO 8601 date: YYYY-MM-DD), inclusive.

periodTodateerforderlich

Last day of the absence (ISO 8601 date: YYYY-MM-DD), inclusive.

sourceVacationRequestIduuidoptional

Backlink to the approved vacation_request the period was pre-filled from.

nullable
statusstringoptional

DRAFT while the wizard is open; COMPLETED once the handover has been applied.

Werte
DRAFTCOMPLETED
Default: "DRAFT"
notestringoptional

Optional overall note for the handover.

max 2000 Zeichennullable
notifyUserIdsuuid[]optional

Internal user IDs that get an in-app notification when the handover is created. They are ALSO granted read access to this handover (see ADR 0197).

max 100 ItemsDefault: []nullable
notifyUserNamesstring[]optional

Denormalized display names parallel to `notifyUserIds` (same order), for the UI chips. Display-only; the IDs are authoritative.

max 100 ItemsDefault: []nullable
itemsobject[]optional

Embedded snapshot of each covered ticket/task and its handover action.

Default: []nullable
entityTypestringerforderlich

Which kind of entity this item refers to.

Werte
tickettaskopportunity
entityIduuiderforderlich

UUID of the ticket, task or opportunity.

entityLabelstringoptional

Denormalized label (ticket number + title) for list/audit display.

max 500 Zeichennullable
actionstringerforderlich

REASSIGN = set new technician/owner; DISPATCH = unassign + hand to manual dispatch (tickets only); INFO = only post an internal comment/note (no change); SKIP = leave unchanged. Opportunities support REASSIGN, INFO and SKIP.

Werte
REASSIGNDISPATCHINFOSKIP
Default: "SKIP"
newAssigneeUserIduuidoptional

For action=REASSIGN: the substitute technician (user UUID).

nullable
newAssigneeUserNamestringoptional

Denormalized display name of the substitute, for the detail view.

max 200 Zeichennullable
commentstringoptional

Optional info posted as an internal comment on the ticket/task.

max 4000 Zeichennullable
appliedAtdatetimeoptional

When this item was applied (null until applied).

nullable
appliedResultstringoptional

Outcome of applying this item.

Werte
OKFAILEDnull
nullable
appliedErrorstringoptional

Failure reason when appliedResult=FAILED (e.g. missing permission).

max 500 Zeichennullable
customerNotesobject[]optional

Free customer-referenced hints that are NOT tied to a ticket/task/opportunity. Each is posted as an internal NOTE activity on the referenced customer (party) CRM timeline when the handover is applied, and stays visible in the handover.

max 200 ItemsDefault: []nullable
partyIduuiderforderlich

Customer (party) UUID the hint refers to.

partyNamestringoptional

Denormalized customer display name, for the handover list/detail.

max 300 Zeichennullable
notestringerforderlich

Free-text hint about this customer, posted as an internal NOTE activity.

max 4000 Zeichen
appliedAtdatetimeoptional

When the NOTE activity was posted (null until applied).

nullable
appliedResultstringoptional

Outcome of posting the customer NOTE activity.

Werte
OKFAILEDnull
nullable
appliedErrorstringoptional

Failure reason when appliedResult=FAILED.

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

Suche