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

DMS Signature Schema

Schema-ID
dms_signature
Collection
dms_signatures
Permissions
  • Lesendms_signature_view
  • Anlegendms_signature_create
  • Änderndms_signature_edit
  • Löschendms_signature_delete

Felder

DMS Signature Schema

dms_signatures4 Permissions

Schema for electronic signatures on DMS documents (Elektronische Unterschriften)

documentIduuiderforderlich

Reference to dms_document

signingRequestIduuidoptional

Reference to dms_signing_request (if part of a request)

nullable
documentVersionnumbererforderlich

Version of the document at signing time

≥ 1
documentHashstringerforderlich

SHA-256 hash of the PDF at signing time

64–64 Zeichen
signatureTypestringerforderlich

FES = Fortgeschrittene Elektronische Signatur, QES = Qualifizierte

Werte
FESQES
statusstringerforderlich
Werte
PENDINGSIGNEDREJECTEDEXPIREDREVOKED
Default: "PENDING"
signerIduuidoptional

Codemeta user ID (null for external signers)

nullable
signerNamestringerforderlich

Display name of the signer

1–200 Zeichen
signerEmailemailerforderlich

Email of the signer

signerIpstringoptional

IP address at signing time

read-onlynullable
placementobjectoptional
nullable
pagenumberoptional

Page number (1-based)

≥ 1
xnumberoptional

X position (percentage)

0 – 100
ynumberoptional

Y position (percentage)

0 – 100
widthnumberoptional

Width (percentage)

0 – 100
heightnumberoptional

Height (percentage)

0 – 100
certificatestringoptional

X.509 certificate (PEM) — for FES: self-signed per-tenant CA

read-onlynullable
signatureValuestringoptional

PKCS#7 / CMS signature (Base64)

read-onlynullable
timestampTokenstringoptional

RFC 3161 TSA response (Base64)

read-onlynullable
signedAtdatetimeoptional
nullable
providerstringoptional

Signature provider

Werte
internald-trustsign-meswisscom
Default: "internal"
providerTransactionIdstringoptional

External provider reference

nullable
providerCertificatestringoptional

Provider-issued certificate

nullable
signingOrdernumbererforderlich

Position in multi-signer sequence (1, 2, 3...)

≥ 1
signingTokenstringoptional

Token for email-based signing (like approval tokens)

read-onlynullable
signingTokenExpiresAtdatetimeoptional
nullable
reminderSentAtdatetimeoptional
nullable
rejectionReasonstringoptional
max 2000 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/dms_signatures — Liste, paginiert + filterbar
  • GET /api/v1/dms_signatures/<id> — Einzelne Entity
  • POST /api/v1/dms_signatures — Anlegen
  • PATCH /api/v1/dms_signatures/<id> — Teil-Update
  • DELETE /api/v1/dms_signatures/<id> — Soft-Delete
  • GET /api/v1/dms_signatures/<id>/timeline — Audit + Aktivitäten

Suche