DocumentsApi
All URIs are relative to /api
| Method | HTTP request | Description |
|---|---|---|
| delete | DELETE /documents/{lookup} | Delete document(s) by name |
| list | GET /documents | List documents |
| retrieve | GET /documents/{key} | Download a document |
delete
delete(lookup)
Delete document(s) by name
Deletes generated PDF documents by name, all documents with this name are deleted.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| lookup | String | Document filename | [default to null] |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
list
ListDocumentsResponseDto list(startOffset, limit, nameFilter, template, start)
List documents
List generated PDF documents for the organization with pagination and optional filtering.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| startOffset | String | Pagination offset (0-based), use the startOffset from the previous response | [optional] [default to null] |
| limit | BigDecimal | Maximum number of documents to return (default 100) | [optional] [default to null] |
| nameFilter | String | Partial match filter on document name | [optional] [default to null] |
| template | BigDecimal | Filter by template ID | [optional] [default to null] |
| start | oas_any_type_not_mapped | Pagination offset (0-based) | [optional] [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
retrieve
File retrieve(key, dl)
Download a document
Download a generated PDF document by its filename key.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| key | String | Document filename key | [default to null] |
| dl | String | Set to "1" to force download with Content-Disposition attachment header | [optional] [default to null] |
Return type
File
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/pdf, application/json