Gets a list of report definitions in the system.
| Scope | reports Deprecated scope name: get_settings_report_definitions |
| App Type | All |
| Authorization Type | Access token |
| URI | /v4/settings/reports/definitions?lang={lang}&fields={fields}&category={category}&module={module} |
| HTTP Method | GET |
| Automation Version(s) | 7.3.2 |
| Field or Parameter | Type | Required | Values | Description | Automation Version |
|---|---|---|---|---|---|
| category | string | No | � | The document category. The list of category options varies depending on the document group. | 7.3.2 |
| fields | string | No | � | Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored. | 7.3.2 |
| lang | String | No | � | Indicates the language applied. | 7.3.2 |
| limit | long | No | � | Indicates the number of items that are returned in each page. | 7.3.2 |
| module | string | Yes | Get All Modules | Use to filter by the module. | 7.3.2 |
| offset | long | No | � | Indicates the offset start of each page by the number specified. | 7.3.2 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result[] | result{} | � | 7.3.2 |
| result.description | string | The description of the record or item. | 7.3.2 |
| result.format | string | The report format (PDF, XLS and so on) | 7.3.2 |
| result.id | long | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 |
| result.name | string | The full name for the application contact. | 7.3.2 |
| result.parameters[] | result.parameters{} | Contains the fields that define report parameters. | 7.3.2 |
| result.parameters.name | string | The full name for the application contact. | 7.3.2 |
| result.parameters.nickname | string | The more commonly understood name for a report parameter. | 7.3.2 |
| result.parameters.required | string | Indicates whether or not values for sibling fields are required. | 7.3.2 |
| result.parameters.type | string | The parameter type. | 7.3.2 |
| status | integer | The record status. | 7.3.3 |