/
[PUT] /{id}

[PUT] /{id}

/api/bpm/statistics/report-configurations/{id}

Description

Updates an existing report configuration. The configuration id is provided in the path. Optionally, an organizationId can be provided if the reports should be updated for a non-active organization. By default, the active organization is used.

Updates an existing report configuration. The configuration id is provided in the path. The request body must contain all configuration parameters, including the configuration 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 provided id does not exist but is in the correct format, a new configuration will be created.

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

PUT

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/1E4142D5F1D546BBBE379B3FB9FAD46D

{ "name": "Test", "type": "PROCESS_STATISTIC", "processDefinitionsFamilies": [ { "id": "34307E042258432F8369C2CE72442768" } ], "detailLevel": "OVERVIEW", "configuration": { "numberOfProcesses": true, "numberOfProcessesError": true, "numberOfProcessesPause": true, "numberOfActivities": true, "numberOfActivitiesFinished": true, "numberOfActivitiesUnfinished": true, "numberOfActivitiesPersonalized": true, "numberOfActivitiesError": true, "numberOfActivitiesPause": true, "minProcessRunTime": true, "meanProcessRunTime": true, "maxProcessRunTime": true, "minActivityRunTime": true, "meanActivityRunTime": true, "maxActivityRunTime": true, "minActivityRunTimeFinished": true, "meanActivityRunTimeFinished": true, "maxActivityRunTimeFinished": true, "minActivityRunTimeUnfinished": true, "meanActivityRunTimeUnfinished": true, "maxActivityRunTimeUnfinished": true, "minActivityRunTimePersonalized": true, "meanActivityRunTimePersonalized": true, "maxActivityRunTimePersonalized": true, "numberOfEscalationsProcess": true, "numberOfEscalationsActivity": true, "numberOfEscalationsActivityFinished": true, "numberOfEscalationsActivityUnfinished": true, "numberOfEscalationsActivityPersonalized": true } }

Response
codes

  • 204 - Success: Report configuration successfully updated.

  • 400 - Returned when the request body is incomplete or the id is in an invalid format. All configuration parameters are mandatory and must be provided.

  • 403 - If the user does not have the required role.