POST api/v1/exports/device/{deviceId}/measurements
Request export of measurements for the device.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
deviceId | globally unique identifier |
Required |
Body Parameters
ExportMeasurementsRequestDtoName | Description | Type | Additional information |
---|---|---|---|
StartDate | date |
None. |
|
EndDate | date |
None. |
|
Format | ExportFormat |
None. |
Request Formats
application/json, text/json, application/senml+json
Sample:
{ "StartDate": "2023-02-02T16:17:56.5711004+00:00", "EndDate": "2023-02-02T16:17:56.5711004+00:00", "Format": 0 }
application/xml, text/xml
Sample:
<ExportMeasurementsRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.ExportMeasurements"> <EndDate>2023-02-02T16:17:56.5711004+00:00</EndDate> <Format>Csv</Format> <StartDate>2023-02-02T16:17:56.5711004+00:00</StartDate> </ExportMeasurementsRequestDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ExportSettingDtoName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
DateCreated | date |
None. |
|
Deleted | boolean |
None. |
|
EndDate | date |
None. |
|
FailureReason | string |
None. |
|
Format | string |
None. |
|
StartDate | date |
None. |
|
Status | string |
None. |
|
Links | Collection of LinkDto |
None. |
|
Actions | Collection of LinkDto |
None. |
|
TimeTaken | time interval |
None. |
|
DataPoints | integer |
None. |
|
OwnerId |
The user who requested the export |
globally unique identifier |
None. |
DeviceId |
The device/user this export is for. |
globally unique identifier |
None. |
DeviceIds |
List of deviceId's covered by this export |
Collection of globally unique identifier |
None. |
Response Formats
application/json, text/json, application/senml+json
Sample:
{ "Id": "2e3bc688-bb99-4093-b735-c53fa15db34f", "DateCreated": "2023-02-02T16:17:56.5879753+00:00", "Deleted": true, "EndDate": "2023-02-02T16:17:56.5879753+00:00", "FailureReason": "sample string 5", "Format": "sample string 6", "StartDate": "2023-02-02T16:17:56.5879753+00:00", "Status": "sample string 8", "Links": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "Actions": [ { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" }, { "Href": "sample string 1", "Rel": "sample string 2", "Action": "sample string 3" } ], "TimeTaken": "00:00:00.1234567", "DataPoints": 10, "OwnerId": "fa900e65-1bfd-406c-b4f9-d024390fcd37", "DeviceId": "43a918d9-2205-4bc2-967c-93ef3d75288b", "DeviceIds": [ "559d18dd-9297-4a5a-a32c-7e9dac6c3c9d", "9471504e-0ae2-49f7-9425-eb559fd05f95" ] }
application/xml, text/xml
Sample:
<ExportSettingDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.ExportMeasurements"> <Actions xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </Actions> <DataPoints>10</DataPoints> <DateCreated>2023-02-02T16:17:56.5879753+00:00</DateCreated> <Deleted>true</Deleted> <DeviceId>43a918d9-2205-4bc2-967c-93ef3d75288b</DeviceId> <DeviceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>559d18dd-9297-4a5a-a32c-7e9dac6c3c9d</d2p1:guid> <d2p1:guid>9471504e-0ae2-49f7-9425-eb559fd05f95</d2p1:guid> </DeviceIds> <EndDate>2023-02-02T16:17:56.5879753+00:00</EndDate> <FailureReason>sample string 5</FailureReason> <Format>sample string 6</Format> <Id>2e3bc688-bb99-4093-b735-c53fa15db34f</Id> <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/AnalysisUK.Tinamous.www.ApiControllers.Models.Shared"> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> <d2p1:LinkViewModel> <d2p1:Action>sample string 3</d2p1:Action> <d2p1:Href>sample string 1</d2p1:Href> <d2p1:Rel>sample string 2</d2p1:Rel> </d2p1:LinkViewModel> </Links> <OwnerId>fa900e65-1bfd-406c-b4f9-d024390fcd37</OwnerId> <StartDate>2023-02-02T16:17:56.5879753+00:00</StartDate> <Status>sample string 8</Status> <TimeTaken>PT0.1234567S</TimeTaken> </ExportSettingDto>