[POST] /report-configurations
/api/bpm/statistics/report-configurations
Description | This endpoint is used to create new statistics report configurations. Optionally, an organizationId can be provided if the reports should be updated for a non-active organization. By default, the active organization is used. The request body contains a list of configurations to be created. Each configuration in the list represents a single statistics report configuration and must include all required configuration parameters. For each configuration, the request must include the following information: name, configuration type (PROCESS_STATISTICS, PROCESS_DETAILS), detail level (OVERVIEW, PROCESS_FAMILY, TASK), the list of process definition families associated with the configuration, and all report metric configurations with their active status. 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. If the request is successful, the endpoint returns a list of newly created statistics report configurations with their id and name. |
|---|---|
Required Systemrole | R_WFADM_START (ID = 20) |
Request | POST |
Request Optional Query Parameter |
|
Response | JSON |
Minimum Version | 1.4.0 |
Request |
{
"objects": [
{
"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
}
},
{
"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
}
}]
} |
Result | {
"objects": [
{
"id": "1E4142D5F1D546BBBE379B3FB9FAD46D"
"name": "Dashboard"
},
{
"id": "34307E042258432F8369C2CE72442768"
"name": "Default Details"
}],
"numItems": 2,
"hasMoreItems": false,
"totalNumItems": 2
} |