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

DMS Folder Schema

Schema-ID
dms_folder
Collection
dms_folders
Permissions
  • Lesendms_folder_view
  • Anlegendms_folder_create
  • Änderndms_folder_edit
  • Löschendms_folder_delete

Felder

DMS Folder Schema

dms_folders4 Permissions

Schema for validating DMS folder entities (Ordnerstruktur)

namestringerforderlich

Folder display name

1–200 Zeichen
parentIduuidoptional

Parent folder ID (null = root level)

nullable
pathstringoptional

Full materialized path (e.g. /Rechnungen/2026/)

max 2000 Zeichenread-only
descriptionstringoptional
max 1000 Zeichennullable
iconstringoptional

Icon name for display

max 50 Zeichennullable
colorstringoptional

Color hex for display

max 20 Zeichennullable
defaultDocumentTypeIduuidoptional

Default document type for uploads into this folder

nullable
retentionPolicyIduuidoptional

Retention policy inherited by documents in this folder

nullable
sortOrdernumberoptional

Sort order among siblings

Default: 0
createdFromTemplateIduuidoptional

Folder template that produced this folder (for traceability and re-apply).

nullable
linkedEntityTypestringoptional

Entity type this folder belongs to (party, project, vehicle, …).

max 100 Zeichennullable
linkedEntityIduuidoptional

Entity ID this folder belongs to.

nullable
backendIduuidoptional

Storage backend that physically holds this folder (if any).

nullable
backendItemIdstringoptional

Backend-specific folder identifier (e.g. Graph driveItem id).

max 500 Zeichennullable
resolvedPathstringoptional

Backend-absolute path at creation time (audit + quick display).

max 2000 Zeichennullable
sharePointChangeTagstringoptional

Backend eTag at last sync — used for echo-suppression and 3-way conflict detection.

nullable
sharePointLastModifiedAtdatetimeoptional

SharePoint lastModifiedDateTime captured at last sync.

nullable
sharePointWebUrlstringoptional

SharePoint webUrl for direct linkback from DMS UI.

nullable
syncSourcestringoptional

Origin of the most recent write. Drives echo-suppression in the opposite direction.

localsharepoint
nullable
lastSyncedAtdatetimeoptional

Last successful sync timestamp (in or out).

nullable
syncErrorstringoptional

Last sync error message — cleared on successful sync.

nullable
syncStatestringoptional

Conflict-locking state-machine for folder sync (mirrors dms_document.syncState).

cleanpending_outboundpending_inboundconflictrenamingmigrating
Default: "clean"
filingStatusstringoptional

Folder filing state. missing_in_backend = SharePoint counterpart no longer exists (K2 scenario).

unfiledfiledfiling_failedmissing_in_backend
nullable
originalBackendPathstringoptional

Path at which the folder was first discovered on the backend — source of truth for path-source: origin.

max 2000 Zeichennullable
originalBackendIduuidoptional

Backend that originally delivered this folder (inbound origin). Stable across later moves.

nullable
pathSourcestringoptional

Path-ownership model (ADR 0391): "origin" = backend original (inbound sync), "user" = explicit folder choice, "policy" = filing policy template. Only a policy with overrideBackendPath=true may override "origin"/"user". Folders currently never carry "user" — the value exists so the enum stays symmetric with dms_documents.

originuserpolicy
nullable
lastOutboundMoveAtdatetimeoptional

Timestamp of the most recent successful outbound folder operation.

nullable
lastOutboundMoveJobIdstringoptional

BullMQ jobId of the last outbound-folder attempt (diagnostics + idempotency).

max 200 Zeichennullable
outboundMoveAttemptsintegeroptional

Total outbound attempts (increments on every CAS-lock acquisition).

≥ 0Default: 0
pathRewriteStatusstringoptional

Bulk path-rewrite progress after a folder move. null/done = idle.

pendingin_progressdone
nullable
pathRewriteCursorstringoptional

Cursor for chunked path-rewrite continuation (last processed _id).

max 100 Zeichennullable
pathRewriteFromstringoptional

Source path prefix for the in-progress async rewrite.

max 2000 Zeichennullable
pathRewriteTostringoptional

Target path prefix for the in-progress async rewrite.

max 2000 Zeichennullable
deletedInBackendbooleanoptional

SharePoint counterpart was deleted while DMS-side changes are still pending — needs conflict triage.

Default: false
deletedInBackendAtdatetimeoptional

When the SP-side delete was first observed.

nullable

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

Suche