/
[GET] /report-configurations

[GET] /report-configurations

/api/bpm/statistics/report-configurations

Description

To retrieve configurations for process reports. Optionally, an organizationId could be sent if the process reports should be loaded for a none active organization. By default, the active organization will be used.

The result returns the configuration id, configuration name, configuration type (PROCESS_STATISTICS, PROCESS_DETAILS), detailLevel (OVERVIEW, PROCESS_FAMILY, TASK), list of process definition families associated with the report configuration, configurations representing all report metrics and whether each is active or not.

The list of process definition families can contain the special family id FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF. This process definition family is a constant for all process definition families.

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

GET

Request Optional Query Parameter

  • organizationId (String): The id of the organization where the requested report configurations are located.

Response
Format

JSON

Minimum Version

1.4.0

Request
Example

/api/bpm/statistics/report-configurations

Result
Example

{ "objects": [ { "id": "6B35EC18F1704D21B2DBB1F879DE0DD9", "name": "Dashboard", "type": "PROCESSES_STATISTIC", "processDefinitionsFamilies": [ { "id": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF" } ], "detailLevel": "OVERVIEW", "configuration": { "numberOfProcesses": true, "numberOfProcessesError": true, "numberOfProcessesPause": true, "numberOfActivities": false, "numberOfActivitiesFinished": false, "numberOfActivitiesUnfinished": false, "numberOfActivitiesPersonalized": false, "numberOfActivitiesError": false, "numberOfActivitiesPause": false, "minProcessRunTime": true, "meanProcessRunTime": true, "maxProcessRunTime": true, "minActivityRunTime": false, "meanActivityRunTime": false, "maxActivityRunTime": false, "minActivityRunTimeFinished": false, "meanActivityRunTimeFinished": false, "maxActivityRunTimeFinished": false, "minActivityRunTimeUnfinished": false, "meanActivityRunTimeUnfinished": false, "maxActivityRunTimeUnfinished": false, "minActivityRunTimePersonalized": false, "meanActivityRunTimePersonalized": false, "maxActivityRunTimePersonalized": true, "numberOfEscalationsProcess": true, "numberOfEscalationsActivity": true, "numberOfEscalationsActivityFinished": true, "numberOfEscalationsActivityUnfinished": true, "numberOfEscalationsActivityPersonalized": true } }, { "id": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFE", "name": "Default Details", "type": "PROCESS_DETAILS", "processDefinitionsFamilies": [ { "id": "FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF" } ], "detailLevel": "PROCESS_FAMILY", "configuration": { "processId": true, "processName": true, "processSubject": true, "familyId": true, "familyName": true, "modelId": true, "modelName": true, "processStartTime": true, "processRunTime": true, "processState": true, "numberOfActivities": true, "numberOfActivitiesUnfinished": true, "numberOfActivitiesFinished": true, "numberOfActivitiesPersonalized": true, "numberOfActivitiesError": true, "numberOfActivitiesPause": true, "processDataFields": true, "numberOfEscalationsProcess": true, "numberOfEscalationsActivity": true, "numberOfEscalationsActivityUnfinished": true, "numberOfEscalationsActivityFinished": true, "numberOfEscalationsActivityPersonalized": true, "activityId": true, "modActivityId": true, "activityName": true, "activityStartTime": true, "activityRunTime": true, "activityState": true } }], "numItems": 2, "hasMoreItems": false, "totalNumItems": 2 }