Export subscription

A export subscription.

Create a export subscription

Create a new export subscription for a tree element.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing export subscription information.

One of:

Create a export subscription for a measure.

name
required
string <= 1000 characters

The name of the new export subscription.

start_time
required
string <date> Y-m-d H:00:00

The start time of the new export subscription.

frequency
required
integer

The frequency of the new export subscription.

  • 1 - Weekdays
  • 2 - Weekly
  • 3 - Monthly
Enum: 1 2 3
status
integer
Default: 0

The status of the new export subscription.

  • 0 - Disabled
  • 1 - Active
Enum: 0 1
users
Array of strings

The subscribed users of the new export subscription.

All users who should subscribe to the export must always be listed here. An empty array indicates that no user has subscribed to the export.

If a user is unknown in the hub, he/she will be removed from the users array without a warning.

export_type
required
integer
Default: 1

The export type of the export created by the new export subscription.

  • 1 - Profile
  • 2 - Process
  • 3 - Schedule
  • 4 - Effects
  • 5 - Status
Enum: 1 2 3 4 5
file_type
integer

The file type of the export created by the new export subscription.

  • 1 - csv
  • 2 - xls
  • 3 - xlsx
Enum: 1 2 3
measure_hash
required
string

The measure of the new export subscription.

Responses
200

Successful operation

422

Unprocessable Content

post/exportsubscription
Request samples
application/json
{
  • "name": "Monday Turnover Export",
  • "start_time": "2022-10-03 09:00:00",
  • "frequency": 2,
  • "status": 1,
  • "export_type": 4,
  • "users": [
    ],
  • "measure_hash": "952d544cd1d50a3937b903ee9f0322808baba201"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "b53bf0d1e402a10797f257ebbdc640e954fdaaca",
  • "data": {
    },
  • "timestamp": 1666082081074
}

Get all export subscriptions

Get all export subscriptions of the authenticated hub.

SecurityJWT
Responses
200

Successful operation

get/exportsubscription
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "739b1e16f61830806c56df63c629d734f7023645",
  • "data": [
    ],
  • "timestamp": 1666082658299
}

Get a export subscription

Get a export subscription.

SecurityJWT
Request
path Parameters
exportsubscription
required
string or integer

The id/hash of the export subscription.

Responses
200

Successful operation

404

Not Found

get/exportsubscription/{exportsubscription}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "4a50ada7815d75e032252b5becbf92af912a3187",
  • "data": {
    },
  • "timestamp": 1666083175808
}

Update a export subscription

Update a export subscription.

SecurityJWT
Request
path Parameters
exportsubscription
required
string or integer

The id/hash of the export subscription.

Request Body schema: application/json

A JSON object containing export subscription information.

name
string <= 1000 characters

The export subscription name.

start_time
string <date> Y-m-d H:00:00

The start time of the export subscription.

frequency
integer

The frequency of the export subscription.

  • 1 - Weekdays
  • 2 - Weekly
  • 3 - Monthly
Enum: 1 2 3
status
integer

The status of the export subscription.

  • 0 - Disabled
  • 1 - Active
Enum: 0 1
users
Array of strings

The subscribed users of the export subscription.

All users who should subscribe to the export must always be listed here. An empty array indicates that no user has subscribed to the export.

If a user is unknown in the hub, he/she will be removed from the users array without a warning.

file_type
integer

The file type of the export created by the export subscription.

  • 1 - csv
  • 2 - xls
  • 3 - xlsx
Enum: 1 2 3
Responses
200

Successful operation

404

Not Found

422

Unprocessable Content

put/exportsubscription/{exportsubscription}
Request samples
application/json
{
  • "status": "1,",
  • "users": [
    ]
}
Response samples
application/json
{
  • "success": true,
  • "hash": "7e52dea8accbc9af2e0ce1e11bc3cdc7c08bbb34",
  • "data": {
    },
  • "timestamp": 1666083413161
}

Delete a export subscription

Delete a export subscription.

SecurityJWT
Request
path Parameters
exportsubscription
required
string or integer

The id/hash of the export subscription.

Responses
200

Successful operation

404

Not Found

delete/exportsubscription/{exportsubscription}
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": [ ],
  • "timestamp": 1665585346483
}

Cancel a export subscription

Cancel a export subscription for the authenticated user.

SecurityJWT
Request
path Parameters
exportsubscription
required
string or integer

The id/hash of the export subscription.

Responses
200

Successful operation

404

Not Found

put/exportsubscription/{exportsubscription}/cancel
Request samples
Response samples
application/json
{
  • "success": true,
  • "hash": "ed06d294e6458ee54ddffe783dcfbc58d51c2083",
  • "data": {
    },
  • "timestamp": 1666083721223
}