Dokumenty i podpisy
Dokumenty, przechowywanie i żądania podpisu elektronicznego — przesyłaj, porządkuj i podpisuj pliki.
Dokument
Endpoints
| GET | /documents | Pobiera kolekcję zasobów Document. |
| POST | /documents | Tworzy zasób Document. |
| GET | /documents/{id} | Pobiera zasób Document. |
| PATCH | /documents/{id} | Aktualizuje zasób Document. |
| DELETE | /documents/{id} | Usuwa zasób Document. |
| GET | /documents/action-needed | Pobiera kolekcję zasobów Document. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| documentType* | string (iri-reference) | |
| relationId* | integernull | |
| relationUuid | stringnull | |
| expiringAt | string,null (date-time) | |
| storage* | string (iri-reference) | |
| notes | stringnull |
Storage
Endpoints
| GET | /storage/{id} | Pobiera zasób Storage. |
| DELETE | /storage/{id} | Usuwa zasób Storage. |
| GET | /storage/{id}/preview | Preview file |
| GET | /storage/mt940 | Pobiera kolekcję zasobów Storage. |
| POST | /storage/upload | Tworzy zasób Storage. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| id | string | |
| relationName* | string | |
| relationId* | string | |
| size | integer | |
| mimeType | string |
Typ dokumentu
Endpoints
| GET | /document-types | Pobiera kolekcję zasobów DocumentType. |
| POST | /document-types | Tworzy zasób DocumentType. |
| GET | /document-types/{id} | Pobiera zasób DocumentType. |
| PATCH | /document-types/{id} | Aktualizuje zasób DocumentType. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| name* | string | |
| relationName* | string | |
| required | boolean | |
| expiring | boolean | |
| description | stringnull |
Żądanie podpisu
Endpoints
| GET | /signature-requests | Pobiera kolekcję zasobów SignatureRequest. |
| POST | /signature-requests | Tworzy zasób SignatureRequest. |
| GET | /signature-requests/{id} | Pobiera zasób SignatureRequest. |
| DELETE | /signature-requests/{id} | Usuwa zasób SignatureRequest. |
| GET | /signature-requests/{id}/signature-status | Live per-signer signing status for a signature request. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| 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) |