Get data-export by id

  • 1 minute(s) read
Prev Next
Get
/data/dataExports/{dataExportId}

Retrieves the details of a specific data-export.
Schedule a data-export by calling the [POST] /data/dataExports method, and then wait for the COMPLETE state by invoking this method issuing the data-export identifier.
When completed use the url property value to download the generated archive, which contains a CSV for each exported thing.

Required permissions: EXPORT_DATA.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Path parameters
dataExportId
stringRequired

The identifier of the data-export to retrieve.

Minimum1.0
Exampleabcd1234
Responses
200

Successful operation.

object

The bean providing data-export details.

id
string

The data-export unique identifier.

name
string

The data-export friendly name.

ExampleAllTemperatures_march_20200
dateTime
integer (int64)

The timestamp UTC the data-export has been scheduled.

Example1578438000000
thingFileName
string

The file name mask (without .CSV extension) used for the generated CSV files.

Example${thing.serialNumber}_${thingDefinition.name}
hashThingFileName
boolean

The flag indicating whether the file name (without extension) must be anonimized through an MD5 hashing.

state
string

The data-export status.

Valid values[ "PENDING", "COMPLETED", "ABORTED" ]
thingDefinitionIds
Array of string

The list of thing-definition identifiers whose associated thing data must be exported.

string
metricIds
Array of string

The list of metric identifiers whose associated data must be exported.

string
startTimestamp
integer (int64)

The start timestamp UTC related to the exported period of data.

Example1578438000000
endTimestamp
integer (int64)

The end timestamp UTC related to the exported period of data.

Example1578438000000
url
string

The data-export genrated archive URL (available only retrieving the data-export details).

401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error