post https://example.com/dms/v1/data/reports/export
Create a new Report
The following API create a new snapshot of the system's DB state (report) according to the parameters provided to the API. After the export process finishes the data will be accessible to the user by getting the report created in the system
Request Body Parameters:
| Parameter | Type | Mandatory | Description | Example |
|---|---|---|---|---|
| queries | array | false | A list that containing queries (filter) on the wanted data export. Supported filters: [_lastModifiedTime, _creationTime, _templateId]. Supported sorts: [_creationTime] | |
| queries[index] | array | false | A list that containing queries (filter) on the wanted data export. Supported filters: [_lastModifiedTime, _creationTime, _templateId]. Supported sorts: [_creationTime] | |
| queries[index].dataType | string | true | 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 | false | 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 | false | 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 | false | 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 | true | The property name for the sort | |
| queries[index].sort[index].order | string | false | The direction of sort. Default DESC Values:ASC,DESC | ASC |
| outputMetadata | object | true | ||
| outputMetadata.maxFileSizeInBytes | integer | false | The maximum size (in bytes) that each output file should not exceed | 500000 |
| outputMetadata.exportFormat | string | true | The format in which to export the report Values:JSON,CSV | JSON |
| callbackEndpoint | string | false | URL endpoint to call when export process is finished | https://my-url.com/ |
| name | string | false | Name of the report | BioT Devices Export |
This API requires PROTECTED_API permission(s).