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

Filing Policy Schema

Schema-ID
filing_policy
Collection
filing_policies
Permissions
  • Lesenfiling_policy_view
  • Anlegenfiling_policy_create
  • Ändernfiling_policy_edit
  • Löschenfiling_policy_delete

Felder

Filing Policy Schema

filing_policies4 Permissions

Deklarative Ablageregel: welcher Dokumenttyp (oder MIME-Pattern) in welchem Entity-Kontext wird unter welchem Pfad + Dateinamen an welchem Backend abgelegt.

namestringerforderlich
1–200 Zeichen
descriptionstringoptional
max 1000 Zeichennullable
activebooleanoptional
Default: true
priorityintegererforderlich
0 – 1000Default: 50
documentTypeIduuidoptional
nullable
matchMimeTypesstring[]optional

MIME-type matcher, supports wildcards like `image/*`.

nullable
entityContextobjectoptional
nullable
entityTypestringerforderlich
1–100 Zeichen
conditionsobject[]optional
nullable
fieldstringerforderlich
1–200 Zeichen
opstringerforderlich
Werte
eqneqinninexistsnexistsgtgteltltecontainsstartsWithendsWithmatches
valueanyoptional

Operand — type depends on the operator. `in`/`nin` expect arrays.

classificationstring[]optional
nullable
backendIduuiderforderlich
pathTemplatestringerforderlich
1–2000 Zeichen
filenameTemplatestringerforderlich
1–500 Zeichen
overrideBackendPathbooleanoptional

Wenn true, ersetzt diese Policy den ursprünglichen Backend-Pfad (originalBackendPath) eines per Inbound-Sync übernommenen Dokuments. Standardmäßig (false) bleibt der Original-Pfad bestehen — Policies greifen dann nur für Dokumente ohne Origin (z.B. DMS-Direkt-Uploads). Aktiviert zugleich ein physisches Move im Quell-Backend.

Default: false
onExistingFilestringerforderlich
Werte
renameversionreplacefail
Default: "version"
onStateChangeobjectoptional
nullable
fieldstringerforderlich
1–200 Zeichen
transitionsobject[]erforderlich
fromValuestringerforderlich
toValuestringerforderlich
newPathTemplatestringerforderlich
1–2000 Zeichen
requiredFieldsstring[]optional
nullable
onDeleteobjectoptional
nullable
dmsSoftDeletestringerforderlich
Werte
ignoresoft_delete_spmove_to_trash_folderhard_delete_sp
dmsRetentionExpirystringerforderlich
Werte
soft_delete_sphard_delete_spadmin_report_only

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

Suche