Export API
Fetch export packages list
GET
/api/v1/export-packages?exportProfileId={exportProfileId}&dateFrom={dateFrom}&dateTo={dateTo} |
QueryParams
Param | Type | Description | Mandatory |
---|---|---|---|
exportProfileId | Long | Id of the export profile for which the export packages are being fetched | Yes |
dateFrom | Date in format YYYY-MM-DD | Filtering parameter for fetching only the export packages that were created after this date (including) | No |
dateTo | Date in format YYYY-MM-DD | Filtering parameter for fetching only the export packages that were created before this date (including) | No |
Response - List of ExportPackage entities
ExportPackage
Field | Type | Description |
id | Long | Unique identifier of the export package |
creationDate | Date in format YYYY-MM-DDTHH:mm:ss.mmmZ | Creation date of the export package |
documentName | string | Name of the exported document |
revisionLabel | string | Revision label of the exported document |
documentId | string | unique identifier of the document |
documentVersionId | string | unique identifier of the revision |
effectiveFrom | Date in format YYYY-MM-DDTHH:mm:ss.mmmZ | Date on which the revision becomes effective |
Errors
Code | Error |
---|---|
200 | Success |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
Fetch export package content
GET
/api/v1/export-packages/{exportPackageId} |
PathParams
Param | Type | Description | Mandatory |
---|---|---|---|
exportPackageId | Long | Id of the export package for which the content is fetched | Yes |
Response - ExportPackage content
content-disposition: attachment; filename="{exportPackage-fileName}"
content-type: application/octet-stream
Errors
Code | Error |
---|---|
200 | Success |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |