Report subscription

A report subscription.

Create a report subscription

Create a new report subscription for a tree element.

SecurityJWT
Request
Request Body schema: application/json

A JSON object containing report subscription information.

One of:

Create a report subscription for a measure.

name
required
string <= 1000 characters

The name of the report subscription.

start_time
required
string <date>

The start time of the report subscription.

The date must have the format Y-m-d H:00:00.

frequency
required
integer

The frequency of the report subscription.

  • 1 - Weekdays
  • 2 - Weekly
  • 3 - Monthly
Enum: 1 2 3
report_type
required
integer

The report type of the report created by the report subscription.

  • 1 - Overview
  • 2 - Detail

Enum: 1 2
file_type
integer

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

  • 1 - pptx
Value: 1
factor
integer or null

The factor of the report created by the report subscription.

  • 0 - None
  • 1 - Thousand
  • 2 - Million

Without a factor, the factor selected for the elements in the budgeting item will be used to create the report.

Enum: null 0 1 2
decimals
integer or null [ 0 .. 5 ]

The number of displayed decimals of the report created by the report subscription.

Without a decimals, the decimals selected for the elements in the budgeting item will be used to create the report.

period_type
integer or null

The period type of the report created by the report subscription.

  • 1 - Overall
  • 2 - Pre previous year
  • 3 - Previous year
  • 4 - Year to date
  • 5 - Actual year
  • 6 - Date to year
  • 7 - Upcoming year
  • 8 - Last year
  • 9 - Start to date
  • 10 - Rolling year to date
  • 11 - Pre previous period
  • 12 - Previous period
  • 13 - Actual period
  • 14 - Upcoming period
  • 15 - Date to rolling year
  • 16 - Date to end
  • 17 - Last period

Without a period type, the period type selected for the elements in the budgeting item will be used to create the report.

Enum: null 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
scaling
integer or null

The scaling of the report created by the report subscription.

  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly

The selected scaling must be equal to or smaller than the scaling of the selected budgeting for the reportable element. Without a scaling, the scaling of the selected budgeting for the reportable element is used to create the report.

Enum: null 1 2 3 4
budgeting_item
string or integer or null

The budgeting item of the report created by the report subscription.

Without a budgeting item, the selected budgeting item of each tree element will be used to create the report.

status
integer

The status of the report subscription.

  • 0 - Disabled
  • 1 - Active
Enum: 0 1
measure
required
string

The measure of the report subscription.

users
Array of strings

The subscribed users of the report subscription.

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

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

Responses
200

Successful operation

422

Unprocessable Content

post/reportsubscription
Request samples
application/json
{
  • "name": "Monday Turnover Report",
  • "start_time": "2022-10-03 09:00:00",
  • "frequency": 2,
  • "report_type": 2,
  • "status": 1,
  • "users": [
    ],
  • "measure": "952d544cd1d50a3937b903ee9f0322808baba201"
}
Response samples
application/json
{
  • "success": true,
  • "hash": "ed2cb71964b3d56f06f53b42fc43730df2d42f28",
  • "data": {
    },
  • "timestamp": 1665577302735
}

Get all report subscriptions

Get all report subscriptions of the authenticated hub.

SecurityJWT
Request
query Parameters
page
integer
Default: 1

The page number of the response.

Responses
200

Successful operation

get/reportsubscription
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "41590202b3ff4f7f26834b83329b7303f01f6921",
  • "data": [
    ],
  • "meta": {
    },
  • "timestamp": 1665579163061
}
Get a report subscription
Get a report subscription.


SecurityJWT 
Request 
path Parameters
reportsubscription
required
string or integer
The id/hash of the report subscription.


 
Responses 
200
Successful operation


404
Not Found


get/reportsubscription/{reportsubscription}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "771973563d76533b3a952fe668cdc47fd2ce715e",
  • "data": {
    },
  • "timestamp": 1665581958997
}
Update a report subscription
Update a report subscription.


SecurityJWT 
Request 
path Parameters
reportsubscription
required
string or integer
The id/hash of the report subscription.


 
Request Body schema: application/json
A JSON object containing report subscription information.


name
string  <= 1000 characters 
The report subscription name.


 
start_time
string <date> 
The start time of the report subscription.
The date must have the format Y-m-d H:00:00.
 
frequency
integer
The frequency of the report subscription.


    

  • 1 - Weekdays
    • 

  • 2 - Weekly
    • 

  • 3 - Monthly
    • 



 Enum: 1 2 3  
report_type
integer
The report type of the report created by the report subscription.
  • 1 - Overview
  • 2 - Detail
  • 3 - Summary
The report type cannot be changed to Summary for measure report subscriptions.
 Enum: 1 2 3  
file_type
integer
The file type of the report created by the report subscription.


    

  • 1 - pptx
    • 



 Value: 1  
factor
integer or null
The factor of the report created by the report subscription.
  • 0 - None
  • 1 - Thousand
  • 2 - Million
Without a factor, the factor selected for the elements in the budgeting item will be used to create the report.
 Enum: null 0 1 2  
decimals
integer or null  [ 0 .. 5 ] 
The number of displayed decimals of the report created by the report subscription.
Without a decimals, the decimals selected for the elements in the budgeting item will be used to create the report.
 
period_type
integer or null
The period type of the report created by the report subscription.
  • 1 - Overall
  • 2 - Pre previous year
  • 3 - Previous year
  • 4 - Year to date
  • 5 - Actual year
  • 6 - Date to year
  • 7 - Upcoming year
  • 8 - Last year
  • 9 - Start to date
  • 10 - Rolling year to date
  • 11 - Pre previous period
  • 12 - Previous period
  • 13 - Actual period
  • 14 - Upcoming period
  • 15 - Date to rolling year
  • 16 - Date to end
  • 17 - Last period
Without a period type, the period type selected for the elements in the budgeting item will be used to create the report.
 Enum: null 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17  
scaling
integer or null
The scaling of the report created by the report subscription.
  • 1 - Weekly
  • 2 - Monthly
  • 3 - Quarterly
  • 4 - Yearly
The selected scaling must be equal to or smaller than the scaling of the selected budgeting for the reportable element. Without a scaling, the scaling of the selected budgeting for the reportable element is used to create the report.
 Enum: null 1 2 3 4  
budgeting_item
string or integer or null
The budgeting item of the report created by the report subscription.
Without a budgeting item, the selected budgeting item of each tree element will be used to create the report.
 
tags
Array of strings or integers
Filters the measures of the reportable element on the tag(s).
With this filter, only measures with the tag(s) are included in the report.
If a tag is unknown in the hub, it will be removed from the input array without a warning.
Measure report subscriptions cannot be filtered by tags.
 
workflow_phases
Array of strings or integers
Filters the measures of the reportable element on the workflow phase(s).
With this filter, only measures with the workflow phase(s) are included in the report.
If a workflow phase is unknown in the hub, it will be removed from the input array without a warning.
Measure report subscriptions cannot be filtered by workflow phases.
 
responsible_users
Array of strings or integers
Filters the measures of the reportable element on the responsible user(s).
With this filter, only measures with the responsible user(s) are included in the report.
If a responsible user is unknown in the hub, it will be removed from the input array without a warning.
Measure report subscriptions cannot be filtered by responsible users.
 
strategic_users
Array of strings or integers
Filters the measures of the reportable element on the strategic user(s).
With this filter, only measures with the strategic user(s) are included in the report.
If a strategic user is unknown in the hub, it will be removed from the input array without a warning.
Measure report subscriptions cannot be filtered by strategic users.
 
status
integer
The status of the report subscription.


    

  • 0 - Disabled
    • 

  • 1 - Active
    • 



 Enum: 0 1  
users
Array of strings
The subscribed users of the report subscription.
All users who should subscribe to the report subscription must be listed here. An empty array indicates that no user has subscribed to the report subscription.
If a user is unknown in the hub, he/she will be removed from the users array without a warning.
 
Responses 
200
Successful operation


404
Not Found


422
Unprocessable Content


put/reportsubscription/{reportsubscription}
Request samples 
application/json
{
  • "status": 1,
  • "users": [
    ]
}
Response samples 
application/json
{
  • "success": true,
  • "hash": "fa9fd1292c3b38221ee4663f0ca2246563d1ef9b",
  • "data": {
    },
  • "timestamp": 1665584519818
}
Delete a report subscription
Delete a report subscription.


SecurityJWT 
Request 
path Parameters
reportsubscription
required
string or integer
The id/hash of the report subscription.


 
Responses 
200
Successful operation


404
Not Found


delete/reportsubscription/{reportsubscription}
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "8739602554c7f3241958e3cc9b57fdecb474d508",
  • "data": { },
  • "timestamp": 1665585346483
}
Cancel a report subscription
Cancel a report subscription for the authenticated user.


SecurityJWT 
Request 
path Parameters
reportsubscription
required
string or integer
The id/hash of the report subscription.


 
Responses 
200
Successful operation


404
Not Found


put/reportsubscription/{reportsubscription}/cancel
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "hash": "41590202b3ff4f7f26834b83329b7303f01f6921",
  • "data": {
    },
  • "timestamp": 1665579163061
}
➔ Next to Schedule