WebAPI

WebAPI – Reports

65 views 21 January, 2020 3 February, 2020 Valuekeep 0

This service allows a user to get reports in Valuekeep.

Below you can find an analysis of the methods available through the service.

Get Report

This method allows to print a report as PDF, using the following parameters:

  • module: report entity module;
  • entity: report entity;
  • reportKey: report code;
  • fileName: export file name (without extension);
  • paramKey and paramValue: key/value pairs that match the report printing parameters.

The module, entity and reportKey parameters are required.

GET /api/mytenant/myorganization/reporting/reports/getreport?module=MyModule&entity=MyEntity&reportKey=MyReport

GET /api/mytenant/myorganization/reporting/reports/getreport?module=MyModule&entity=MyEntity&reportKey=MyReport&fileName=RepXX-123

GET /api/mytenant/myorganization/reporting/reports/getreport?module=MyModule&entity=MyEntity&reportKey=MyReport&fileName=RepXX-123&paramKey=FirstParam&paramValue=FirstValue&paramKey=SecondParam&paramValue=SecondValue

Example:

Print the WO operational report (all WOs).

GET /api/mytenant/myorganization/reporting/reports/getreport?module=MaintenanceManagementCore&entity=WorkOrders&reportKey=WOWORKREPORT

Foi útil?