Previous section   Next section

POST /Data/MDXDrillthrough

Executes a detail listing.

URL Parameters

None. Note that a request body is required; see the next heading.

Request Body Details

This service uses the following properties of the request body:
MDX
Required. MDX SELECT QUERY, preceded by either
DRILLTHROUGH
or
DRILLFACTS
.
Use
DRILLTHROUGH
to use a named detail listing or to retrieve fields from the source class of the cube. Use
DRILLFACTS
to retrieve fields from the fact table.
If the base SELECT query returns more than one cell, only the top left cell is used for the detail listing.
LISTING
Optional. Logical name of the detail listing to use. You must specify either
LISTING
or
RETURN
, but not both.
WAIT
Optional. Specify 0 or 1 (the default). If this property is 0, the server sends partial results. If this property is 1, the server assumes the client wishes to wait for complete results before sending a response.
RETURN
Optional. List of fields in the applicable table, depending on the value in
MDX
. If you specify this, the listing consists of these fields.

Example Request

  • Request Method:
    POST
  • Request URL:
    http://localhost:57772/api/deepsee/v1/Data/MDXDrillthrough
    For comments on the possible forms of the URL, see “Introduction to the DeepSee REST API” in the chapter “Introduction and Samples.”
  • Request Body:
    {
      "MDX" : "DRILLTHROUGH SELECT FROM patients WHERE AGED.60",
      "LISTING" : "Patient details"
    }
    
    For another example:
    {
      "MDX" : "DRILLTHROUGH SELECT FROM patients WHERE AGED.60",
      "RETURN":"Age,BirthDate"
    }
    
    For another example:
    {
      "MDX" : "DRILLFACTS SELECT FROM patients WHERE AGED.60",
      "RETURN":"MxAge,MxTestScore"
    }
    

Example Response

{
 "Info":
        {"Error":"",
         "MDXText":"DRILLTHROUGH SELECT FROM [PATIENTS] WHERE [AGED].[60]",
         "QueryKey":"en2156087935","CubeKey":"PATIENTS",
         "QueryID":"PATIENTS||en2156087935","Cube":"patients",
         "ResultsComplete":1,"Pivot":"","QueryType":"DRILLTHROUGH","ListingSource":"source",
         "ColCount":5,"RowCount":0,"Error":"","TimeStamp":"2016-08-14 15:43:04"},
 "AxesInfo":
      [{"%ID":"SlicerInfo","Text":"[AGED].[60]"},
       {"%ID":"AxisInfo_1","Text":"[%SEARCH]"},
       {"%ID":"AxisInfo_2","Text":"[%SEARCH]"}],
 "Result":
   {"children":
      [
        {"PatientID":"SUBJ_100508","Age":60,"Gender":"Female","Home City":"Elm Heights","Test Score":81},
        {"PatientID":"SUBJ_100539","Age":60,"Gender":"Female","Home City":"Elm Heights","Test Score":90},
        {"PatientID":"SUBJ_100701","Age":60,"Gender":"Female","Home City":"Redwood","Test Score":61},
        {"PatientID":"SUBJ_100829","Age":60,"Gender":"Female","Home City":"Juniper","Test Score":98},
        ...]}
}
For information that applies to all response objects, see the discussion at the start of this reference.
Previous section   Next section