Get All Report Definitions

Gets a list of report definitions in the system.

Resource Information

Scopereports

Deprecated scope name:   get_settings_report_definitions

App TypeAll
Authorization TypeAccess token
URI /v4/settings/reports/definitions?lang={lang}&fields={fields}&category={category}&module={module}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
categorystringNo The document category. The list of category options varies depending on the document group.7.3.2
fieldsstringNo 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
langStringNo Indicates the language applied.7.3.2
limitlongNo Indicates the number of items that are returned in each page.7.3.2
modulestringYes Get All Modules Use to filter by the module.7.3.2
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.descriptionstringThe description of the record or item.7.3.2
result.formatstringThe report format (PDF, XLS and so on)7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.namestringThe 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.namestringThe full name for the application contact.7.3.2
result.parameters.nicknamestringThe more commonly understood name for a report parameter.7.3.2
result.parameters.requiredstringIndicates whether or not values for sibling fields are required.7.3.2
result.parameters.typestringThe parameter type.7.3.2
statusintegerThe record status.7.3.3