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

Partner Document Schema

Schema-ID
partner_document
Collection
partner_documents
Permissions
  • Lesenpartner_manage
  • Anlegenadmin_bypass
  • Ändernadmin_bypass
  • Löschenadmin_bypass

Felder

Partner Document Schema

partner_documents4 Permissions

Versionierte Unterlage für Tippgeber (Vertragsanlagen, Logos, CD-Handbuch). Plattform-global.

tenantIdnulloptional
read-only
partnerIdstringoptional
read-onlynullable
seriesIdstringerforderlich
min 1 Zeichenread-only
documentVersionintegererforderlich
≥ 1read-only
categorystringerforderlich
Werte
agreementbrandsalesproductother
read-only
titlestringerforderlich
1–200 Zeichenread-only
descriptionstringoptional
max 2000 Zeichenread-onlynullable
changeNotestringoptional
max 1000 Zeichenread-onlynullable
fileNamestringerforderlich
1–255 Zeichenread-only
mimeTypestringoptional
max 200 Zeichenread-only
sizeBytesintegeroptional
≥ 0read-only
storageKeystringerforderlich
min 1 Zeichenread-only
contentSha256stringoptional
read-onlynullable
s3VersionIdstringoptional
read-onlynullable
publishedAtdatetimeerforderlich
read-only
withdrawnAtdatetimeoptional
read-onlynullable
withdrawnBystringoptional
read-onlynullable
withdrawnReasonstringoptional
max 1000 Zeichenread-onlynullable
deletedReasonstringoptional
max 1000 Zeichenread-onlynullable

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

Suche