/api/reports/:id/filters

Lists filters and values in reports

Resource Information

Resource URL

https://service.belladati.com/api/reports/:id/filters

HTTP Method

GET

Request Parameters

id

Id of report

123

availableValues

(Optional) Name of filter can be passed here. Then it will return all possible values, that can be set for this filter

company

setFilters

(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

limit

(Optional) Sets maximum count of retrieved availableValues. Default value=500, Recommended maximum=32000

2000

Response Structure

{

  "id" : 0,
  "filters" : [ ]
}

JSON response contains id element but the main element is array "filters" that contains multiple filters objects with following definition:

idReport identifier
typeType of filter
codeFilter code
nameDisplayed name of filter
attributeTo what attribute is filter connected to
display mode

Display mode used for filter

select typeType of select used for filter
autosubmitInformation if values are autosubmited
operatorRelation operator type
requiredFlags if filter is required

Sample Request / Response

Using curl:

curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/reports/123/filters

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      

        }

    ]

}


  • No labels