Report API

The Report API Resource is used to read records based on the Platform report framework, i.e. ".reports" files.

To add a new Report API, select "Report" under "Rest APIs" and click "Add Report API Resource" from the context menu or toolbar:

The developer must provide a unique resource name (automatically prefixed with module prefix to avoid conflicts across modules) and report name to define a Report API.

Both report override and injections (if available) will be honored for a report, but the JSON listener defined on a report will not be honored. Instead, the developer can provide an optional listener class implementing to manipulate the Report API request and response.

The Report API provides the following APIs: