Documenti e firme

Documenti, archiviazione e richieste di firma elettronica — carica, organizza e firma i file.

Documento

Endpoint

GET	/documents	Recupera la raccolta di risorse Document.
POST	/documents	Crea una risorsa Document.
GET	/documents/{id}	Recupera una risorsa Document.
PATCH	/documents/{id}	Aggiorna la risorsa Document.
DELETE	/documents/{id}	Rimuove la risorsa Document.
GET	/documents/action-needed	Recupera la raccolta di risorse Document.

Campi schema

Campo	Tipo	Descrizione
documentType*	string (iri-reference)
relationId*	integernull
relationUuid	stringnull
expiringAt	string,null (date-time)
storage*	string (iri-reference)
notes	stringnull

Archiviazione

Endpoint

GET	/storage/{id}	Recupera una risorsa Storage.
DELETE	/storage/{id}	Rimuove la risorsa Storage.
GET	/storage/{id}/preview	Preview file
GET	/storage/mt940	Recupera la raccolta di risorse Storage.
POST	/storage/upload	Crea una risorsa Storage.

Campi schema

Campo	Tipo	Descrizione
id	string
relationName*	string
relationId*	string
size	integer
mimeType	string

Tipo di documento

Endpoint

GET	/document-types	Recupera la raccolta di risorse DocumentType.
POST	/document-types	Crea una risorsa DocumentType.
GET	/document-types/{id}	Recupera una risorsa DocumentType.
PATCH	/document-types/{id}	Aggiorna la risorsa DocumentType.

Campi schema

Campo	Tipo	Descrizione
name*	string
relationName*	string
required	boolean
expiring	boolean
description	stringnull

Richiesta di firma

Endpoint

GET	/signature-requests	Recupera la raccolta di risorse SignatureRequest.
POST	/signature-requests	Crea una risorsa SignatureRequest.
GET	/signature-requests/{id}	Recupera una risorsa SignatureRequest.
DELETE	/signature-requests/{id}	Rimuove la risorsa SignatureRequest.
GET	/signature-requests/{id}/signature-status	Live per-signer signing status for a signature request.

Campi schema

Campo	Tipo	Descrizione
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)