Report

The Report Service provides the ability to get the list of available reports, get the metadata (including query parameters) for a report, and executing a report to get the PDF output.

Run Report

Run a report for the given criteria.

SecurityJWT
Request
path Parameters
reportPath
required
string
Request Body schema:
required
Array of objects (ParameterValue)

List of Parameters defining the criteria for an operation

Responses
200

Success

404

Not Found

500

Internal Server Error

post/cw/report/runReport/{reportPath}
Request samples
{
  • "parameterList": [
    ]
}

Get Report Metadata

Retrieve the available report parameters.

SecurityJWT
Request
path Parameters
reportPath
required
string
Responses
200

Success

404

Not found

500

Internal Server Error

get/cw/report/getReportMetadata/{reportPath}
Request samples
Response samples
{
  • "queryPath": "Business Units",
  • "parameterDefs": [
    ]
}

List Reports

Get a list of available reports

SecurityJWT
Responses
200

Success

500

Internal Server Error

get/cw/report/listReports
Request samples
Response samples
{
  • "rows": [
    ],
  • "totalCount": 0
}