Schedules a new data-export

Prev Next
Post
/data/dataExports

Note that, depending on the amount of data to export, a data-export may require several minutes to complete.
Checkout periodically the data-export status, by calling the get details method issuing the data-export identifier.
Limitations:
- Only one bulk export can be scheduled at a time.
- Only the archives of the completed exports during the last 30 days are keep stored for further downloads.

Required permissions: EXPORT_DATA.

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

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

Body parameters

The details of the scheduled data-export.

Expand All
object

The bean providing data-export details.

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.

customerId
string

The identifier of the customer whose data is to be exported.

locationId
string

The identifier of the location whose data is to be exported.

thingId
string

The identifier of the thing whose data is to be exported.

qualifiedMetricIds
Array of object

The array of metric identifier to export along their thing-definition or model and part ids.

object
metricId
string

The metric identifier.

productModelId
string

The product model identifier.

productModelPartId
string

The product model part identifier.

thingDefinitionId
string

The thing-definition identifier in alternative to the product model and part.

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
includeUnit
boolean

The flag that indicates whether to include the unit of measurement in CSV header names (Weight [kg]).

timestampFormat
string

The format that the timestamp must have in the result CSV file.

Valid values[ "ISO_8601", "EPOCH_MILLIS" ]
Responses
201

Successful created.

Expand All
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", "ERROR" ]
customerId
string

The identifier of the customer whose data is to be exported.

locationId
string

The identifier of the location whose data is to be exported.

thingId
string

The identifier of the thing whose data is to be exported.

qualifiedMetricIds
Array of object

The array of metric identifier to export along their thing-definition or model and part ids.

object
metricId
string

The metric identifier.

productModelId
string

The product model identifier.

productModelPartId
string

The product model part identifier.

thingDefinitionId
string

The thing-definition identifier in alternative to the product model and part.

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
includeUnit
boolean

The flag that indicates whether to include the unit of measurement in CSV header names (Weight [kg]).

timestampFormat
string

The format that the timestamp must have in the result CSV file.

Valid values[ "ISO_8601", "EPOCH_MILLIS" ]
url
string

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

400

Request data not valid.

object
message
string

The error response.

ExampleBad request
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
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