Create a new Report

The below table describes the response parameters:

Parameter	Type	Description	Example
queries	array	A list that containing queries (filter) on the wanted data export. Supported filters: [_lastModifiedTime, _creationTime, _templateId]. Supported sorts: [_creationTime]
queries[index]	array	A list that containing queries (filter) on the wanted data export. Supported filters: [_lastModifiedTime, _creationTime, _templateId]. Supported sorts: [_creationTime]
queries[index].dataType	string	Data Type to be exported. Values:device,device-alert,usage-session,command,organization,patient,organization-user,caregiver,patient-alert,generic-entity,measurements,registration-code	device
queries[index].filter	object	Each additionalProp can filter one field, inside additionalProp there are many optional conditions that can be used for filtering that field. When multiple conditions are specified, they are bundled together using logical AND operators, this means that only the items that match all filter conditions for that field will be returned
queries[index].sort	array	Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort.The first field is the primary sort, the second is used when two values of the first field are the same, and so forth
queries[index].sort[index]	array	Results can be sorted by multiple fields, the order of the fields in the sort request governs the hierarchy of the sort.The first field is the primary sort, the second is used when two values of the first field are the same, and so forth
queries[index].sort[index].prop	string	The property name for the sort
queries[index].sort[index].order	string	The direction of sort. Default DESC Values:ASC,DESC	ASC
outputMetadata	object
outputMetadata.maxFileSizeInBytes	integer	The maximum size (in bytes) that each output file should not exceed	500000
outputMetadata.exportFormat	string	The format in which to export the report Values:JSON,CSV	JSON
callbackEndpoint	string	URL endpoint to call when export process is finished	https://my-url.com/
name	string	Name of the report	BioT Devices Export
id	string	A UUID formatted string	3fa85f64-5717-4562-b3fc-2c963f66afa6
status	string	The report current status Values:IN_PROGRESS,COMPLETED,FAILED,CANCELING,CANCELED	IN_PROGRESS
fileOutput	object
fileOutput.filesLocation	object	An object that holds for each data type exported, A list containing the paths to it's files
fileOutput.urlExpirationTime	string	A UTC date-time in the ISO-8601 format	2007-12-20T10:15:30Z
reportInitiator	object
reportInitiator.userId	string	The user ID of the initiator of the report
reportInitiator.ownerOrganizationId	string	The owner organization ID of the initiator of the report
reportInitiator.userEntityType	string	The entity type of the initiator of the report
reportInitiator.templateId	string	The template ID of the initiator of the report
creationTime	string
lastModifiedTime	string
errorMessage	string

400Code : QUERIES_MUST_HAVE_DISTINCT_ENTITY_TYPE, Details: [] Code : MISSING_FILTERS, Details: [missingMandatoryFilters] Code : TIMESTAMP_FROM_TO_MISSING, Details: [] Code : INVALID_TIME_RANGE, Details: [fromTime, toTime, currentTime]

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

404Code : ENTITY_TYPE_NOT_SUPPORTED, Details: [dataType]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []