/api/reports/:id/filters
Lists filters and values in reports
Resource Information
Resource URL | https://service.belladati.com/api/reports/:id/filters |
---|---|
HTTP Method |
|
Request Parameters
| Id of report | 123 |
| (Optional) Name of filter can be passed here. Then it will return all possible values, that can be set for this filter | company |
| (Optional) If availableValues is set, you can specify what filters should be set. This will return all possible values for additional filter connected to that filter. | Europe |
| (Optional) Sets maximum count of retrieved availableValues. Default value=500, Recommended maximum=32000 | 2000 |
Response Structure
|
JSON response contains id element but the main element is array "filters" that contains multiple filters objects with following definition:
id | Report identifier |
type | Type of filter |
code | Filter code |
name | Displayed name of filter |
attribute | To what attribute is filter connected to |
display mode | Display mode used for filter |
select type | Type of select used for filter |
autosubmit | Information if values are autosubmited |
operator | Relation operator type |
required | Flags if filter is required |
Sample Request / Response
Using curl
:
|
The JSON format response:
{ "id": 123, "filters": [{ "type": "FILTER", "code": "fiscalPeriod", "name": "Fiscal period", "attribute": "L_FISCAL_PERIOD", "displayMode": "DEFAULT", "selectType": "SELECT", "autosubmit": false, "operator": "IN", "required": true } ] } |