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[]

Array [

id stringrequired

Column id.

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

label stringrequired

Column label

]

timezone object

Default value: utc

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
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]
ResourceExportItemParamsDto
type stringrequired
ids string[]
include string
sort string
filter object
page object
limit number
offset number
filename string
]
periodicity string

Possible values: Value must match regular expression durationRegExp

ISO8601 Duration: https://en.wikipedia.org/wiki/ISO_8601#Durations

notification objectrequired
messages object[]required
Array [
policy stringrequired
Possible values: [onSuccess, onFailure]
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[]

Array [

id stringrequired

Column id.

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

label stringrequired

Column label

]

timezone object

Default value: utc

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
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]
ResourceExportItemParamsDto
type stringrequired
ids string[]
include string
sort string
filter object
page object
limit number
offset number
filename string
]
periodicity string

Possible values: Value must match regular expression durationRegExp

ISO8601 Duration: https://en.wikipedia.org/wiki/ISO_8601#Durations

notification objectrequired
messages object[]required
Array [
policy stringrequired
Possible values: [onSuccess, onFailure]
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": {},
    "template": "tabular"
  },
  "type": "recurring",
  "items": [
    {
      "params": {},
      "filename": "string"
    }
  ],
  "periodicity": "P1Y6M4DT12H30M5S",
  "notification": {
    "messages": [
      {
        "policy": "onSuccess",
        "medium": "email",
        "title": "string",
        "text": "string"
      }
    ]
  },
  "id": "string",
  "createdAt": "2024-07-18T14:21:17.736Z",
  "updatedAt": "2024-07-18T14:21:17.736Z",
  "deletedAt": "2024-07-18T14:21:17.736Z"
}

400

Missing user identity id

429

Maximum number of queued exports reached

Loading...