Create export request
POST/exports
Create export request.
Authorization Action:
exporter:exports:create
Request
- application/json
Body
required
format objectrequired
type stringrequired
Possible values: [recurring
, oneTime
]
items object[]required
periodicity string
Possible values: Value must match regular expression durationRegExp
ISO8601 Duration: https://en.wikipedia.org/wiki/ISO_8601#Durations
periodStart number
Period start expressed in Unix timestamp. If not specified, the creation date of the request will be used.
notification objectrequired
Responses
- 201
- 400
- 429
- application/json
- Schema
- Example (from schema)
Schema
format objectrequired
type stringrequired
Possible values: [recurring
, oneTime
]
items object[]required
periodicity string
Possible values: Value must match regular expression durationRegExp
ISO8601 Duration: https://en.wikipedia.org/wiki/ISO_8601#Durations
periodStart number
Period start expressed in Unix timestamp. If not specified, the creation date of the request will be used.
notification objectrequired
id stringrequired
createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired
{
"format": {
"extension": "csv",
"columns": [
{
"id": "string",
"label": "string"
}
],
"timezone": "utc",
"template": "tabular"
},
"type": "recurring",
"items": [
{
"params": {},
"filename": "string"
}
],
"periodicity": "P1Y6M4DT12H30M5S",
"periodStart": 0,
"notification": {
"messages": [
{
"policy": "onSuccess",
"medium": "email",
"title": "string",
"text": "string"
}
]
},
"id": "string",
"createdAt": "2025-01-13T15:42:36.049Z",
"updatedAt": "2025-01-13T15:42:36.049Z",
"deletedAt": "2025-01-13T15:42:36.049Z"
}
Missing user identity id
Maximum number of queued exports reached
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X POST 'https://connhex.com/exports' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"format": {
"extension": "csv",
"columns": [
{
"id": "string",
"label": "string"
}
],
"timezone": "utc",
"template": "tabular"
},
"type": "recurring",
"items": [
{
"params": {
"target": {
"value": "urn:cpt:smartdevice:nid:D0CF5EFFFE26FDAB1:onoff",
"label": "onoff"
},
"channelId": "0115c85d-ef3e-4de9-9732-d0c5c4f2c482",
"subtopic": "events.data",
"from": 0,
"to": 0,
"period": "P1Y6M4DT12H30M5S",
"decimation": {
"ds": "15m",
"dsf": "avg"
},
"transform": "delta"
},
"filename": "string"
}
],
"periodicity": "P1Y6M4DT12H30M5S",
"periodStart": 0,
"notification": {
"messages": [
{
"policy": "onSuccess",
"medium": "email",
"title": "string",
"text": "string"
}
]
}
}'