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

Employee Onboarding Schema

Schema-ID
employee_onboarding
Collection
employee_onboardings
Permissions
  • Lesenemployee_onboarding_view
  • Anlegenemployee_onboarding_create
  • Ändernemployee_onboarding_edit
  • Löschenemployee_onboarding_delete

Felder

Employee Onboarding Schema

employee_onboardings4 Permissions

Process record for onboarding a new 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), hardware/account tasks active; DONE = onboarding complete; CANCELLED = aborted. Server-managed by the onboarding orchestration — never client-written via generic PATCH.

Werte
DRAFTHRSECOND_LEVELDONECANCELLED
Default: "DRAFT"read-only
employeeProfileIduuidoptional

employee_profiles UUID provisioned for this hire (set on processing).

read-onlynullable
ticketIduuidoptional

tickets UUID of the generated onboarding ticket.

read-onlynullable
submittedByIduuidoptional

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

nullable
orgUnitIduuidoptional

Target org unit / department (Abteilung) for the new employee.

nullable
displayNamestringoptional

Full name of the new employee, for list display (firstName + lastName).

max 400 Zeichennullable
emailstringoptional

Suggested work email of the new employee (Firmen-E-Mail-Vorschlag).

max 320 Zeichennullable
startDatedateoptional

Suggested first day of employment (Eintrittsdatum).

nullable
requestedSystemsstring[]optional

Keys of the systems/accounts requested 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.onboarding.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_onboardings — Liste, paginiert + filterbar
  • GET /api/v1/employee_onboardings/<id> — Einzelne Entity
  • POST /api/v1/employee_onboardings — Anlegen
  • PATCH /api/v1/employee_onboardings/<id> — Teil-Update
  • DELETE /api/v1/employee_onboardings/<id> — Soft-Delete
  • GET /api/v1/employee_onboardings/<id>/timeline — Audit + Aktivitäten

Suche