Entity · dms_signing_requests

DMS Signing Request Schema

Schema-ID

dms_signing_request

Collection

dms_signing_requests

Permissions

Lesendms_signing_request_view
Anlegendms_signing_request_create
Änderndms_signing_request_edit
Löschendms_signing_request_delete

Felder

DMS Signing Request Schema

dms_signing_requests4 Permissions

Schema for grouping multiple signatures for one document (Unterschriftenanfrage)

documentIduuiderforderlich

Reference to dms_document

titlestringerforderlich

Title of the signing request

1–500 Zeichen

statusstringerforderlich

Werte

DRAFTIN_PROGRESSCOMPLETEDCANCELLEDEXPIRED

Default: "DRAFT"

signersobject[]erforderlich

min 1 Items

signerIduuidoptional

Internal user ID (optional for external signers)

nullable

signerNamestringerforderlich

1–200 Zeichen

signerEmailemailerforderlich

rolestringerforderlich

VIEWER gets copy but does not sign

Werte

SIGNERAPPROVERVIEWER

ordernumbererforderlich

Sequential order (1 = first signer)

≥ 1

placementobjectoptional

nullable

pagenumberoptional

≥ 1

xnumberoptional

0 – 100

ynumberoptional

0 – 100

widthnumberoptional

0 – 100

heightnumberoptional

0 – 100

sequentialbooleanerforderlich

true = sign in order, false = parallel signing

Default: true

messagestringoptional

Message to signers

max 5000 Zeichennullable

expiresAtdatetimeoptional

Deadline for all signatures

nullable

completedDocumentIduuidoptional

ID of final signed PDF (new document version)

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