/Info/FilterMembers/:datasource/:filterSpec
Request Method
GET or POST
URL Parameters
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.
Required. Filter specification.
Request Body Details
This endpoint uses the following properties of the request body. These properties both specify filters that are applied to the data source, thus limiting the list of members returned by the endpoint.
Optional. If specified, this property is an array of objects, each of which contains the spec property (a filter specification) and the value property (value of that filter). A value property should be an MDX set expression and should use member keys.
Optional.
Example Request
-
Request Method:
POST
-
Request URL:
https://localhost/api/deepsee/v3/Info/FilterMembers/:demomdx.kpi/:homed.h1.zip
For comments on the possible forms of the URL, see Introduction to the Business Intelligence REST API.
-
Request Body:
{ "RELATED":[ {"spec":"gend.h1.gender","value":"&[female]"} ], "SEARCHKEY":"Jan" }
Example Response
{
"Info": {
"Error":"",
"DataSource":"demomdx.cube",
"DataSourceType":"cube",
"Default":"",
"Filter":"[HomeD].[H1].[ZIP]"
},
"Result": {
"FilterMembers": [
{"text":"32006","value":"&[32006]","description":""},
{"text":"32007","value":"&[32007]","description":""},
{"text":"34577","value":"&[34577]","description":""},
{"text":"36711","value":"&[36711]","description":""},
{"text":"38928","value":"&[38928]","description":""}
]
}
}
In the response object, the Result property contains a property called FilterMembers, which contains an array of objects, one for each filter member. The object for a given filter member contains the following properties:
-
description contains the text description of the member, if any
-
text contains the display text for the member
-
value contains the logical value of the member (typically the MDX key)
For information that applies to all response objects, see Notes on the Response Objects.
