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

Required Document Rule Schema

Schema-ID
required_document_rule
Collection
required_document_rules
Permissions
  • Lesenrequired_document_rule_view
  • Anlegenrequired_document_rule_create
  • Ändernrequired_document_rule_edit
  • Löschenrequired_document_rule_delete

Felder

Required Document Rule Schema

required_document_rules4 Permissions

Tenant-/OU-/Position-scoped declaration of a document that an employee must provide (ADR 0112)

documentTypeIduuiderforderlich

FK to dms_document_type — the kind of document required.

documentTypeNamestringerforderlich

Snapshot of dms_document_type.name at rule creation time. Cached for display so a deleted document type does not blank-out the UI.

1–200 Zeichen
scopeobjecterforderlich
kindstringerforderlich
Werte
TENANTORG_UNITPOSITION
orgUnitIduuidoptional

Required when kind='ORG_UNIT'.

nullable
positionIduuidoptional

Required when kind='POSITION'.

nullable
mandatorybooleanoptional

When true, missing this document is a compliance violation. False = nice-to-have, surfaced in the UI but does not flag red.

Default: true
blockingForOnboardingbooleanoptional

When true, the employee's onboarding state is held open until the document is on file. The onboarding-checklist generator surfaces these as auto-items.

Default: false
renewalIntervalMonthsintegeroptional

Document expires after this many months and must be renewed. Null = once, no renewal (e.g. employment contract). Used to compute expiry status against employee_documents.validUntil.

1 – 240nullable
validFromdateoptional

Optional: rule only takes effect from this date (e.g. "DSGVO-Schulung is mandatory from 2026-07-01").

nullable
validTodateoptional

Optional: rule expires on this date.

nullable
descriptionstringoptional

Free-text note for HR admins, shown in the rule editor.

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

Suche