POST /Info/Filters/:datasource

Returns information about the filters available for the given data source (which is either a cube or a KPI).

URL Parameters

datasource

Required. Name of the data source. This is one of the following:

cubename — a logical cube name
cubename.cube — a logical cube name, followed by .cube
kpiname.kpi — a logical KPI name, followed by .kpi

This name can include slashes; see “Use of Slashes in Cube and KPI Names,” earlier in this book.

Request Body Details

This service ignores the request body.

Example Request

Request Method:

POST
Request URL:

http://localhost:57772/api/deepsee/v1/Info/Filters/:aviationevents

For comments on the possible forms of the URL, see “Introduction to the DeepSee REST API” in the chapter “Introduction and Samples.”

Example Response

{
   "Info":
       {"Error":"","DataSource":"aviationevents.cube","DataSourceType":"cube"},
   "Result":
       {"Filters":
          [
           {"caption":"Year","value":"[EventDateD].[H1].[Year]","type":"year"},
           {"caption":"Month","value":"[EventDateD].[H1].[Month]","type":""},
           {"caption":"Day","value":"[EventDateD].[H1].[Day]","type":""}
           ...]
       }
}

In the response object, the Result property contains a property called Filters, which contains an array of objects, one for each filter. Each object has the following properties:

caption contains the display value for the filter.
type contains the filter type, if it exists. This can be "calc" or can be the name of a time function. In other cases it is empty.
value contains the filter specification, which is the logical identifier for the filter. For information on the filter specification, see POST /Info/FilterMembers/:datasource/:filterSpec.

For information that applies to all response objects, see the discussion at the start of this reference.