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

Setting Override Schema

Schema-ID
setting_override
Collection
setting_overrides
Permissions
  • Lesensetting_override_view
  • Anlegensetting_override_create
  • Ändernsetting_override_edit
  • Löschensetting_override_delete

Felder

Setting Override Schema

setting_overrides4 Permissions

Generic hierarchical settings storage (ADR 0098)

settingKeystringerforderlich

Dotted lowercase key, e.g. "working_time.weekly_hours", "approval.budget_limit_eur", "hr.required_documents". The catalog of well-known keys is documented in ADR 0098.

1–200 ZeichenPattern
scopestringerforderlich

Scope this override applies to. The settings-resolver tries USER → POSITION → OU-chain → TENANT and returns the first non-null hit.

TENANTORG_UNITPOSITIONUSER
scopeIduuidoptional

UUID of the scoped entity. Null only when scope=TENANT (the row applies to the whole tenant).

nullable
valueanyoptional

Effective value when this override wins resolver evaluation.

validFromdateoptional

Effective from this date (inclusive). Null = since-forever. Useful for working-time changes that take effect on a specific date.

nullable
validTodateoptional

Effective until this date (inclusive). Null = open-ended.

nullable
approvalRequiredbooleanoptional

When true (e.g. working-time changes at TENANT/ORG_UNIT scope requiring Betriebsrat approval), the override only applies once approvalState=APPROVED.

Default: false
approvalStatestringoptional

Workflow state. Resolver only honours overrides with state=APPROVED. DRAFT rows are visible to admins but do not affect resolution.

DRAFTAPPROVEDREJECTED
Default: "APPROVED"
reasonstringoptional

Free-text justification for the override (audit trail / Betriebsrat-Vorlage).

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

Suche