REST API for Oracle Essbase

Execute Drill Through Report

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/reports/{name}

Executes a drill through report in the specified application and database, and returns records.

Request

Supported Media Types

application/json

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.
name(required): string

Drill through report name.

Drill through metadata. In the example request body, dtrContext corresponds to the intersection of cells in Smart View.

Root Schema : DrillthroughMetadataBean

Type: object

Show Source

aliasTable: string

Optional. Alias table specifying member aliases to use in the drill through report. If unspecified, the default Essbase alias table is used.
dtrContext: array dtrContext

The intersection of cells in Smart View.
sessionId: string

{
    "type":"object",
    "properties":{
        "dtrContext":{
            "type":"array",
            "description":"<p>The intersection of cells in Smart View.</p>",
            "items":{
                "$ref":"#/definitions/DrillThroughRange"
            }
        },
        "aliasTable":{
            "type":"string",
            "description":"<p>Optional. Alias table specifying member aliases to use in the drill through report. If unspecified, the default Essbase alias table is used.</p>"
        },
        "sessionId":{
            "type":"string"
        }
    }
}

Nested Schema : dtrContext

Type: array

The intersection of cells in Smart View.

Show Source

Array of: object DrillThroughRange

{
    "type":"array",
    "description":"<p>The intersection of cells in Smart View.</p>",
    "items":{
        "$ref":"#/definitions/DrillThroughRange"
    }
}

Nested Schema : DrillThroughRange

Type: object

Show Source

cells: object cells

Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "cells":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "uniqueItems":true,
                "items":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : cells

Type: object

Additional Properties Allowed

Show Source

array additionalProperties

Unique Items Required: true

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "uniqueItems":true,
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Unique Items Required: true

Show Source

Array of: string

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

The drillthrough report was executed successfully. Result is a JSON array where the first node is the datatype of each column, the second node is the column names, and the remaining nodes are the data nodes corresponding to each record in the report.

400 Response

Bad Request

Failed to execute the drillthrough report.

415 Response

Not Acceptable

The media type isn't supported or wasn't specified.

500 Response

Internal Server Error.

Examples

The following example shows how to execute a drill through report definition.

This example uses cURL to access the REST API from a Windows shell script. The calling user's ID and password are variables whose values are set in properties.bat.

Script with cURL Command

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/sampleDtr" -H Accept:application/json -H Content-Type:application/json --data "@./dtrcontext.json" -u %User%:%Password%

Sample JSON Payload

The cURL example above delivers the following JSON payload in dtrcontext.json.

{
 "aliasTable":"default",
 "dtrContext":[
   {
     "cells":{
       "Year":["Jan"],
       "Product":["Cola"],
       "Measures":["Sales"],
       "Market":["New York"],
       "Scenario":["Scenario"]}
   }, {
     "cells":{
       "Year":["Aug"],
       "Product":["Cola"],
       "Measures":["Sales"],
       "Market":["New York"],
       "Scenario":["Scenario"]}
   }
  ]
}

Example of Response Body

The following example shows the contents of the response body. The result is a JSON array, where the first node is the data type of each column, the second node lists the column names, and the remaining nodes are the data nodes corresponding to each record in the report. This example output is truncated for length.

[ [ "STRING", "STRING", "STRING", "STRING", "STRING" ], 
[ "PRODUCT", "MONTH", "CITY", "SALES", "COGS" ], 
[ "100-10", "Aug", "New York", "910", "364" ], 
[ "100-10", "Aug", "New York", "860", "340" ], 
[ "100-10", "Aug", "New York", "910", "364" ], 
[ "100-10", "Aug", "New York", "860", "340" ], 
...
]