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

Employee Offboarding Schema

Schema-ID
employee_offboarding
Collection
employee_offboardings
Permissions
  • Lesenemployee_offboarding_view
  • Anlegenemployee_offboarding_create
  • Ändernemployee_offboarding_edit
  • Löschenemployee_offboarding_delete

Felder

Employee Offboarding Schema

employee_offboardings4 Permissions

Process record for offboarding an employee (configurable form + workflow state)

stagestringerforderlich

Workflow stage. DRAFT = just submitted/not yet processed; HR = waiting on HR to complete person master data (employee_profile incomplete); SECOND_LEVEL = HR done (or skipped), deactivation/return tasks active; DONE = offboarding complete; CANCELLED = aborted. Server-managed by the offboarding orchestration — never client-written via generic PATCH.

Werte
DRAFTHRSECOND_LEVELDONECANCELLED
Default: "DRAFT"read-only
employeeProfileIduuidoptional

employee_profiles UUID of the exiting employee (set at submit).

read-onlynullable
ticketIduuidoptional

tickets UUID of the generated offboarding ticket.

read-onlynullable
submittedByIduuidoptional

Internal users UUID of the team lead who submitted the form.

nullable
orgUnitIduuidoptional

Org unit / department (Abteilung) of the exiting employee.

nullable
displayNamestringoptional

Full name of the exiting employee, for list display.

max 400 Zeichennullable
emailstringoptional

Work email of the exiting employee.

max 320 Zeichennullable
exitDatedateoptional

Last day of employment (Austrittsdatum).

nullable
requestedSystemsstring[]optional

Keys of the systems/accounts to deactivate as selected in the form (Confluence, Baramundi, …). Quick-access copy; the canonical source is formData.

Default: []nullable
formDataobjecterforderlich

Raw submitted values keyed by the configurable form field ids (tenant.settings.offboarding.formDefinition).

Default: {}
missingEmployeeFieldsstring[]optional

Snapshot of the employee_profile fields that were missing at submit time and routed the ticket to HR (drives the HR person-data tasks).

Default: []read-onlynullable
notesstringoptional

Free-text remarks (Besonderheiten).

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

Suche