Dokument och signaturer

Dokument, lagring och e-signeringsförfrågningar — ladda upp, organisera och signera filer.

Dokument

Endpoints

GET	/documents	Hämtar samlingen av Document-resurser.
POST	/documents	Skapar en Document-resurs.
GET	/documents/{id}	Hämtar en Document-resurs.
PATCH	/documents/{id}	Uppdaterar Document-resursen.
DELETE	/documents/{id}	Tar bort Document-resursen.
GET	/documents/action-needed	Hämtar samlingen av Document-resurser.

Schema-fält

Fält	Typ	Beskrivning
documentType*	string (iri-reference)
relationId*	integernull
relationUuid	stringnull
expiringAt	string,null (date-time)
storage*	string (iri-reference)
notes	stringnull

Lagring

Endpoints

GET	/storage/{id}	Hämtar en Storage-resurs.
DELETE	/storage/{id}	Tar bort Storage-resursen.
GET	/storage/{id}/preview	Preview file
GET	/storage/mt940	Hämtar samlingen av Storage-resurser.
POST	/storage/upload	Skapar en Storage-resurs.

Schema-fält

Fält	Typ	Beskrivning
id	string
relationName*	string
relationId*	string
size	integer
mimeType	string

Dokumenttyp

Endpoints

GET	/document-types	Hämtar samlingen av DocumentType-resurser.
POST	/document-types	Skapar en DocumentType-resurs.
GET	/document-types/{id}	Hämtar en DocumentType-resurs.
PATCH	/document-types/{id}	Uppdaterar DocumentType-resursen.

Schema-fält

Fält	Typ	Beskrivning
name*	string
relationName*	string
required	boolean
expiring	boolean
description	stringnull

Signeringsförfrågan

Endpoints

GET	/signature-requests	Hämtar samlingen av SignatureRequest-resurser.
POST	/signature-requests	Skapar en SignatureRequest-resurs.
GET	/signature-requests/{id}	Hämtar en SignatureRequest-resurs.
DELETE	/signature-requests/{id}	Tar bort SignatureRequest-resursen.
GET	/signature-requests/{id}/signature-status	Live per-signer signing status for a signature request.

Schema-fält

Fält	Typ	Beskrivning
id	string
documentTitle	string
status	stringnull
sentAt	string,null (date-time)
completedAt	string,null (date-time)
sourceFilename	stringnull
signersSummary	array
contract	string,null (iri-reference)
createdAt	string (date-time)