[POST] /report

[POST] /report

/api/bpm/processes/report

Description

An endpoint to create and download reports for specific processes by providing the process ID in the request body in order to document the state of the process in detail. The report provides comprehensive information about the processes, which can be exported in either XML or CSV format. The format of the report is determined by the Accept header, where users can specify either application/xml for XML format or text/csv for CSV format.

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

POST

Request Query Parameter

  • filename (string): The file name how the download xml or csv file should be called. If it's null, then its default name is "report".

  • exportGlobalVariables (boolean): Determines whether global variables should be included in the report.

  • exportDocumentInformation (boolean): Determines whether information about the WF file should be included in the report.

Response
Format

JSON

Minimum Version

1.0.0

Request
Example

{ "objects": [{ "id": "2A42437656884AB6A90171C07D8C3870" },{ "id": "8A5C400C277B499CA26ED17E67F84841" }] }

Result
Example

The result is a report containing detailed information about the specified processes, provided in either XML or CSV format based on the request.