Interfacing with BIRT reports using REST apis
Starting 7609 REST apis support interfacing with BIRT reports. We provide 2 basic apis:
- Get the list of available reports for a given user and a given application.
- Generate a report for a given set of mbos.
Below we show a sample of the “get list of reports” api for the MXAPIWODETAIL object structure with a sample response.
GET /oslc/os/mxapiwodetail?action=listreports
Expected Result:
[{"reportname": "woprint.rptdesign","description": "Work Order Details","genreport": "http://localhost:7001/maximo/oslc/os/MXAPIWODETAIL?action=genreport&reportname=woprint.rptdesign"},{"reportname": "wotrack.rptdesign","description": "Work Order List",
Note that for the object structure MXAPIWODETAIL, there is an associated auth app to which the reports need to get associated with. The genreport property contains the url for generating individual reports.
GET /oslc/os/MXAPIWODETAIL?action=genreport&reportname=woprint.rptdesign
This will generate the report in the deafult format (PDF). You can specify other supported formats using query parameter reportformat. We can filter the list of mbos using the oslc.where query parameter. Additionally we can also add attachments to the generated report setting the attachment query parameter to 1 (default value is 0 which implies no attachments).
It also supports report parameters - as rest api query parameters, with the same name.
The generated pdf is returned as a downloadable file as response to this GET request.