Overview

The endpoint retrieves the list of configurable options (switches, checkboxes, dropdowns, etc.) that could be passed when requesting a report via the /api/Reports/{id}/RequestReport endpoint.

Each option includes its name, data type, help text, and whether it's required. These options are defined at the template level and linked to specific reports.

Common Use Cases

Discover available customization options before running a report
Build dynamic UI forms for report parameter selection
Validate report option names and types before submitting a report request
Display help text to users selecting report options
Identify which options are required vs optional