Simulator [CH - QA]
Download
Document download endpoints
Download operation for documents in different formats
This endpoint downloads any document present in the platform using path parameters.
For document downloading, we will proceed as:
GET /download?id=2e3d0448-5bf5-4fd3-926e-36f43c24162a&type=REPORT
The user should provide the type of document to download, report and the ID of the report to download.
To retrieve the document ID, it is present in the operation search available for reports. Please, check the documentation available for document query.
get
Query Parameters
idstring(string)required
UUID type implementing the RFC 4122.
Match pattern:^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
Example:95b1b467-bd69-4436-8181-96c16408c230
typestring
Document type to download
Allowed values:REPORT
Response
application/octet-stream
Response
application/octet-stream
Download document in Base64
string
get/download
Query Parameters
application/octet-stream
QueryType
objectfiltersarray[object]
Filters restricting the search. All of the values in the Array represent AND operation.
Show Child Parameters
restrictionsarray[object]
List of restrictions applied to the collection
Show Child Parameters
Example
FilterType
objectattributestring
Name of the attribute to be restricted, filtered or searched
Example:sessionDate
valuesarray[string]
Value of the filter or restriction done.
Example:20200101, 20200102
Example
UUIDType
stringUUID type implementing the RFC 4122.
Match pattern:^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$
Example