Create export request

POST 
/exports

Create export request.

Authorization Action:

exporter:exports:create

Request

application/json

Body

required

format objectrequired

extension stringrequired

Possible values: [csv, xlsx, pdf]

columns object[]

Define how exported data fields are mapped to the output file

Array [

id stringrequired

Column id.

When exporting resource items it must be formatted as: <type>.<attribute>.

label stringrequired

Column label

]

timezone string

Default value: utc

Target timezone: all data field will be remapped to this timezone

template string

Possible values: [tabular, expanded]

Default value: tabular

type stringrequired

Possible values: [recurring, oneTime]

items object[]required
Array [
params objectrequired
oneOf
MessageExportItemParamsDto
target objectrequired
value stringrequired
Identifier of the resource the be exported: typically a URN
label string
Label that will replace the target value
channelId stringrequired
subtopic stringrequired
Subtopic from which to retrieve data for export
from number
Unix timestamp: number of seconds since 1970 UTC
to number
Unix timestamp: number of seconds since 1970 UTC
period string
Possible values: Value must match regular expression durationRegExp
ISO8601 Duration: https://en.wikipedia.org/wiki/ISO_8601#Durations
decimation object
ds objectrequired
Decimation granularity. Only supports positive integer.
dsf stringrequired
Possible values: [avg, max, min, sum, stddev, variance]
Aggregation algotithm
transform string
Possible values: [delta]
ResourceExportItemParamsDto
type stringrequired
Resource type (e.g. installations, devices, customers, etc.)
ids string[]
IDs of the resources to be exported
include string
Associated resources to be included. For example, if a resource installation has an association to a device resource, by settings include=devices you create export the installations data together with their associated devices.
sort string
filter object
page object
limit number
offset number
ReportItemParamsDto
template objectrequired
Template object in JSON format
elements object[]required
Array [
templateFieldId stringrequired
ID of template key associated to the report element
type stringrequired
Possible values: [text, chart, table]
sources object[]required
Defines the parameters needed to retrieve the data that will be used to fill the template element. Typically, sources has 1 element. However, if you want a chart with multiple plots, you can specify multiple source elements.
Array [
params objectrequired
The parameters associated to the service request
oneOf
MessageExportItemParamsDto
target objectrequired
value stringrequired
Identifier of the resource the be exported: typically a URN
label string
Label that will replace the target value
channelId stringrequired
subtopic stringrequired
Subtopic from which to retrieve data for export
from number
Unix timestamp: number of seconds since 1970 UTC
to number
Unix timestamp: number of seconds since 1970 UTC
period string
Possible values: Value must match regular expression durationRegExp
ISO8601 Duration: https://en.wikipedia.org/wiki/ISO_8601#Durations
decimation object
ds objectrequired
Decimation granularity. Only supports positive integer.
dsf stringrequired
Possible values: [avg, max, min, sum, stddev, variance]
Aggregation algotithm
transform string
Possible values: [delta]
ResourceExportItemParamsDto
type stringrequired
Resource type (e.g. installations, devices, customers, etc.)
ids string[]
IDs of the resources to be exported
include string
Associated resources to be included. For example, if a resource installation has an association to a device resource, by settings include=devices you create export the installations data together with their associated devices.
sort string
filter object
page object
limit number
offset number
service stringrequired
Possible values: [messages, resources]
The service from which to fetch the data
postProc object[]
The post-processing function(s) to apply to the retrieved data
Array [
fn stringrequired
Possible values: [max, min, add, cumSum, mult, avg]
key stringrequired
Defines the key of the object whose value will be processed by the function
params object
Function parameters. Not all processing functions require additional parameters.
]
]
formats object[]required
Defines the formatting parameters of the template element. For example, for elements of type Chart: the chart type, the chart color, etc. If multiple sources elements have been specified, you must define a formats element for each source. So, it must be: len(formats) == len(sources).
Array [
text object
key stringrequired
Defines the key of the object whose value will be displayed in the report
unitKey string
Defines the key of the object whose value will be displayed as unit of measurement
chart object
type stringrequired
Possible values: [bar, line]
xAxis objectrequired
X axis chart parameters
key stringrequired
Defines the key of the object whose value will be plotted in the X axis
options objectrequired
type stringrequired
Possible values: [string, datetime]
format string
Formatting string. If X axis represents time, this will be used to format the date.
yAxis objectrequired
Y axis chart parameters
key stringrequired
Defines the key of the object whose value will be plotted in the Y axis
label string
Chart label
color string
Hexadecimal color string
canvas object
width numberrequired
height numberrequired
table object
columns object[]required
Array [
id stringrequired
Column id.
When exporting resource items it must be formatted as: <type>.<attribute>.
label stringrequired
Column label
]
]
]
filename string
Name of the output file (without extension)
]
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
messages object[]required
Notification messages. For each notification, there must be exactly two notification messages with the two different policies (onSuccess, onFailure)
Array [
policy stringrequired
Possible values: [onSuccess, onFailure]
The notification policy: whether it is associated with a success event (export delivered), or a failure event (export failed)
medium stringrequired
Possible values: [email, telegram, slack, discord]
title stringrequired
text stringrequired
]

Responses

201

application/json

Schema

Schema

format objectrequired

extension stringrequired

Possible values: [csv, xlsx, pdf]

columns object[]

Define how exported data fields are mapped to the output file

Array [

id stringrequired

Column id.

When exporting resource items it must be formatted as: <type>.<attribute>.

label stringrequired

Column label

]

timezone string

Default value: utc

Target timezone: all data field will be remapped to this timezone

template string

Possible values: [tabular, expanded]

Default value: tabular

type stringrequired

Possible values: [recurring, oneTime]

items object[]required
Array [
params objectrequired
oneOf
MessageExportItemParamsDto
target objectrequired
value stringrequired
Identifier of the resource the be exported: typically a URN
label string
Label that will replace the target value
channelId stringrequired
subtopic stringrequired
Subtopic from which to retrieve data for export
from number
Unix timestamp: number of seconds since 1970 UTC
to number
Unix timestamp: number of seconds since 1970 UTC
period string
Possible values: Value must match regular expression durationRegExp
ISO8601 Duration: https://en.wikipedia.org/wiki/ISO_8601#Durations
decimation object
ds objectrequired
Decimation granularity. Only supports positive integer.
dsf stringrequired
Possible values: [avg, max, min, sum, stddev, variance]
Aggregation algotithm
transform string
Possible values: [delta]
ResourceExportItemParamsDto
type stringrequired
Resource type (e.g. installations, devices, customers, etc.)
ids string[]
IDs of the resources to be exported
include string
Associated resources to be included. For example, if a resource installation has an association to a device resource, by settings include=devices you create export the installations data together with their associated devices.
sort string
filter object
page object
limit number
offset number
ReportItemParamsDto
template objectrequired
Template object in JSON format
elements object[]required
Array [
templateFieldId stringrequired
ID of template key associated to the report element
type stringrequired
Possible values: [text, chart, table]
sources object[]required
Defines the parameters needed to retrieve the data that will be used to fill the template element. Typically, sources has 1 element. However, if you want a chart with multiple plots, you can specify multiple source elements.
Array [
params objectrequired
The parameters associated to the service request
oneOf
MessageExportItemParamsDto
target objectrequired
value stringrequired
Identifier of the resource the be exported: typically a URN
label string
Label that will replace the target value
channelId stringrequired
subtopic stringrequired
Subtopic from which to retrieve data for export
from number
Unix timestamp: number of seconds since 1970 UTC
to number
Unix timestamp: number of seconds since 1970 UTC
period string
Possible values: Value must match regular expression durationRegExp
ISO8601 Duration: https://en.wikipedia.org/wiki/ISO_8601#Durations
decimation object
ds objectrequired
Decimation granularity. Only supports positive integer.
dsf stringrequired
Possible values: [avg, max, min, sum, stddev, variance]
Aggregation algotithm
transform string
Possible values: [delta]
ResourceExportItemParamsDto
type stringrequired
Resource type (e.g. installations, devices, customers, etc.)
ids string[]
IDs of the resources to be exported
include string
Associated resources to be included. For example, if a resource installation has an association to a device resource, by settings include=devices you create export the installations data together with their associated devices.
sort string
filter object
page object
limit number
offset number
service stringrequired
Possible values: [messages, resources]
The service from which to fetch the data
postProc object[]
The post-processing function(s) to apply to the retrieved data
Array [
fn stringrequired
Possible values: [max, min, add, cumSum, mult, avg]
key stringrequired
Defines the key of the object whose value will be processed by the function
params object
Function parameters. Not all processing functions require additional parameters.
]
]
formats object[]required
Defines the formatting parameters of the template element. For example, for elements of type Chart: the chart type, the chart color, etc. If multiple sources elements have been specified, you must define a formats element for each source. So, it must be: len(formats) == len(sources).
Array [
text object
key stringrequired
Defines the key of the object whose value will be displayed in the report
unitKey string
Defines the key of the object whose value will be displayed as unit of measurement
chart object
type stringrequired
Possible values: [bar, line]
xAxis objectrequired
X axis chart parameters
key stringrequired
Defines the key of the object whose value will be plotted in the X axis
options objectrequired
type stringrequired
Possible values: [string, datetime]
format string
Formatting string. If X axis represents time, this will be used to format the date.
yAxis objectrequired
Y axis chart parameters
key stringrequired
Defines the key of the object whose value will be plotted in the Y axis
label string
Chart label
color string
Hexadecimal color string
canvas object
width numberrequired
height numberrequired
table object
columns object[]required
Array [
id stringrequired
Column id.
When exporting resource items it must be formatted as: <type>.<attribute>.
label stringrequired
Column label
]
]
]
filename string
Name of the output file (without extension)
]
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
messages object[]required
Notification messages. For each notification, there must be exactly two notification messages with the two different policies (onSuccess, onFailure)
Array [
policy stringrequired
Possible values: [onSuccess, onFailure]
The notification policy: whether it is associated with a success event (export delivered), or a failure event (export failed)
medium stringrequired
Possible values: [email, telegram, slack, discord]
title stringrequired
text stringrequired
]
id stringrequired
createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired

Example (from schema)

{
  "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"
}

400

Missing user identity id

429

Maximum number of queued exports reached

Loading...