API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen

POST /v1/dms-signing-requests

POST/v1/dms-signing-requests

Create a signing request for a DMS document

Datenmodell

Diese Operation arbeitet auf der Entität DMS Signing Request (dms_signing_request). Alle 8 Felder — Typ, Validierung, Pflichtangabe, Beziehungen — stehen in der Schema-Referenz.

  • Pflichtfelder: documentId, title, status, signers, sequential
  • Server-verwaltet: _id, schema, schemaVersion, tenantId, version, createdAt, updatedAt, createdBy, updatedBy, deletedAt, deletedBy, completedDocumentId — diese Felder vergibt die Plattform; im Request werden sie verworfen.

Request Body

NameTypBeschreibung
documentIderforderlichstring
titleerforderlichstring
signerserforderlichobject[]
sequentialerforderlichboolean
messagestring
expiresAtstring<date-time>

Beispiel

curl -X POST https://api.codemeta-os.de/v1/dms-signing-requests \
  -H "X-Tenant-Id: $TENANT" \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  -d '{
  "documentId": "string",
  "title": "string",
  "signers": [],
  "sequential": false,
  "message": "string",
  "expiresAt": "string"
}'
const result = await cm.dms-signing-requests.post({
  "documentId": "string",
  "title": "string",
  "signers": [],
  "sequential": false,
  "message": "string",
  "expiresAt": "string"
});

Antwortcodes

HTTP Bedeutung
200 Default Response

Suche