Report as a Service
Custom Reports
Custom Reports (advanced type) can be exposed as a Web Service to be used programmatically.
How to find JSON endpoint
Find URL in Actions > Web Service > View URLs > JSON (right click and choose "Copy URL")
Filter parameters
Prompts behave like request parameters. In the UI, it is presented as input fields before generating actual report. As a REST endpoint, these prompts are passed as request parameters.
Report User Interface
JSON Example
Basic Setup
Report type
Switch to advanced type if not already. Only Advanced custom reports can be used in RaaS.
Add prompts
Add all default prompts that are required of web-service-enabled reports
Add additional prompts desired
In this example, Base Pay is assigned to Prompt Qualifier as Prompt #1, which will be used in filters.
Apply logic to filter prompt values
Use values from Prompt to compare against report column values. Example, assign Prompt parameter Base Pay as Prompt #1
When generating a report, Base Pay parameter will be checked. If a value if provided, only records with Base Pay greater than the provided value will be included in the report.