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

ExportMeasurementsRequestDto

Name	Type	Additional information
StartDate	date	None.
EndDate	date	None.
Format	ExportFormat	None.

Request Formats

application/json, text/json, application/senml+json

Sample:

{
  "StartDate": "2024-11-21T09:01:38.6796031+00:00",
  "EndDate": "2024-11-21T09:01:38.6796031+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>2024-11-21T09:01:38.6796031+00:00</EndDate>
  <Format>Csv</Format>
  <StartDate>2024-11-21T09:01:38.6796031+00:00</StartDate>
</ExportMeasurementsRequestDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ExportSettingDto

Name	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": "6acf1839-4f8c-4021-abdd-d073b84bddac",
  "DateCreated": "2024-11-21T09:01:38.6796031+00:00",
  "Deleted": true,
  "EndDate": "2024-11-21T09:01:38.6796031+00:00",
  "FailureReason": "sample string 5",
  "Format": "sample string 6",
  "StartDate": "2024-11-21T09:01:38.6796031+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": "99bcd1b7-619d-494f-bcb0-0631017838ab",
  "DeviceId": "2589e8b3-6b92-4ece-9081-404dc0c5f03e",
  "DeviceIds": [
    "8be39e3a-21b4-4df1-a2c4-cf592af79967",
    "5c9f0179-67b3-4859-b942-01e0e720c924"
  ]
}

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>2024-11-21T09:01:38.6796031+00:00</DateCreated>
  <Deleted>true</Deleted>
  <DeviceId>2589e8b3-6b92-4ece-9081-404dc0c5f03e</DeviceId>
  <DeviceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>8be39e3a-21b4-4df1-a2c4-cf592af79967</d2p1:guid>
    <d2p1:guid>5c9f0179-67b3-4859-b942-01e0e720c924</d2p1:guid>
  </DeviceIds>
  <EndDate>2024-11-21T09:01:38.6796031+00:00</EndDate>
  <FailureReason>sample string 5</FailureReason>
  <Format>sample string 6</Format>
  <Id>6acf1839-4f8c-4021-abdd-d073b84bddac</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>99bcd1b7-619d-494f-bcb0-0631017838ab</OwnerId>
  <StartDate>2024-11-21T09:01:38.6796031+00:00</StartDate>
  <Status>sample string 8</Status>
  <TimeTaken>PT0.1234567S</TimeTaken>
</ExportSettingDto>