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

Employee Document Schema

Schema-ID
employee_document
Collection
employee_documents
Permissions
  • Lesenemployee_document_view
  • Anlegenemployee_document_create
  • Ändernemployee_document_edit
  • Löschenemployee_document_delete

Felder

Employee Document Schema

employee_documents4 Permissions

Schema for validating employee document entities (Personalakte-Dokumente)

employeeIduuiderforderlich

UUID of the employee profile

userIduuiderforderlich

User UUID of the employee

titlestringerforderlich

Document title

1–500 Zeichen
categorystringerforderlich

Document category for the personnel file

Werte
CONTRACTCERTIFICATESICK_NOTEEVALUATIONTRAININGID_DOCUMENTOTHER
fileIduuiderforderlich

UUID of the uploaded file

fileNamestringerforderlich

Original file name

max 500 Zeichen
mimeTypestringerforderlich

MIME type of the file

max 200 Zeichen
validFromdateoptional

Document validity start date

nullable
validUntildateoptional

Document expiry date (for certification tracking)

nullable
isConfidentialbooleanoptional

Whether only HR admins can access this document

Default: false
notesstringoptional

Additional notes

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

Suche