To understand the reports API please refer to Introduction to Reports.
Purpose - Use the Run Reports endpoint to run and receive specific reporting data from the database by passing the report name as a path parameter. Reports are pre-configured in the system according to bank requirements.
Behaviour - The default output is a JSON-formatted key value pairs which includes both column headings and data of the database query associated with the report. To export this result to CSV format, simply append "&exportCSV=true" to the end of your URL.
If the configuration for flexible report generation is enabled, the output method will be determined based on the preferred output type and the record count in the report. The output method can be one of the following: Email, Download, or Display.
Additionally, if Pentaho reports have been pre-defined, they can be executed through this endpoint. Pentaho reports can be returned in HTML, PDF, or CSV formats.
To understand Pentaho integration refer to Pentaho Official Website
Example Requests:
-
runreports/Client%20Listing?R_officeId=1 -
runreports/Client%20Listing?R_officeId=1&exportCSV=true