REST API for Oracle Essbase

Get MDX Report Details

get

/essbase/rest/v1/applications/{application}/databases/{database}/queries/{query}

Get the details for the specified MDX report.

An MDX report is saved in the cube context.

Request

Path Parameters

application(required): string

Application name.
database(required): string

Database name.
query(required): string

MDX report name.

Response

Supported Media Types

application/json
application/xml

200 Response

MDX report details returned successfully.

Root Schema : NamedQuery

Type: object

Show Source

name: string
query: object Query
type: string

Allowed Values: [ "MDX", "DATA_SOURCE" ]

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "MDX",
                "DATA_SOURCE"
            ]
        },
        "query":{
            "$ref":"#/definitions/Query"
        }
    }
}

Nested Schema : Query

Type: object

Show Source

description: string
preferences: object NamedQueriesPreferences
spec: string

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "spec":{
            "type":"string"
        },
        "preferences":{
            "$ref":"#/definitions/NamedQueriesPreferences"
        }
    }
}

Nested Schema : NamedQueriesPreferences

Type: object

Show Source

cellAttributes: boolean
dataless: boolean

Set to true to omit data values from the output set. Default is false.
formatString: boolean

Set to true to return the formatted values for cells of type text or date, or cells associated with a format string. Default is true.
formatValues: boolean
hideRestrictedData: boolean
meaninglessCells: boolean
memberIdentifierType: string

Allowed Values: [ "NAME", "ALIAS", "UNIQUE_NAME" ]

Specify whether metadata in the output should refer to member names, member aliases, or unique member names (in case of duplicate member enabled outlines).
textList: boolean
urlDrillThrough: boolean

{
    "type":"object",
    "properties":{
        "dataless":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to omit data values from the output set. Default is <b>false</b>.</p>"
        },
        "hideRestrictedData":{
            "type":"boolean"
        },
        "cellAttributes":{
            "type":"boolean"
        },
        "formatString":{
            "type":"boolean",
            "description":"<p>Set to <b>true</b> to return the formatted values for cells of type text or date, or cells associated with a format string. Default is <b>true</b>.</p>"
        },
        "formatValues":{
            "type":"boolean"
        },
        "meaninglessCells":{
            "type":"boolean"
        },
        "textList":{
            "type":"boolean"
        },
        "urlDrillThrough":{
            "type":"boolean"
        },
        "memberIdentifierType":{
            "type":"string",
            "description":"<p>Specify whether metadata in the output should refer to member names, member aliases, or unique member names (in case of duplicate member enabled outlines).</p>",
            "enum":[
                "NAME",
                "ALIAS",
                "UNIQUE_NAME"
            ]
        }
    }
}

400 Response

Bad Request

Failed to get MDX report details.

Examples

The following example shows how to get details of an MDX report saved in the context of an Essbase cube.

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 GET https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/queries/closingperiod -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
  "name" : "closingperiod",
  "type" : "MDX",
  "query" : {
    "spec" : "WITH\nMEMBER [Measures].[Starting Inventory] AS\n'\nIIF (\n IsLeaf (Year.CurrentMember),\n  [Measures].[Opening Inventory],\n  ([Measures].[Opening Inventory],\n   OpeningPeriod (\n     [Year].Levels(0),\n     [Year].CurrentMember\n   )\n  )\n)'\n\nMEMBER [Measures].[Closing Inventory] AS\n'\nIIF (\n   Isleaf(Year.CurrentMember),\n    [Measures].[Ending Inventory],  \n   ([Measures].[Closing Inventory],\n    ClosingPeriod (\n    [Year].Levels(0),\n    [Year].CurrentMember\n    )\n)\n)'\nSELECT\nCrossJoin (\n { [100-10] },\n { [Measures].[Starting Inventory], [Measures].[Closing Inventory] }\n)\nON COLUMNS,\nHierarchize ( [Year].Members , POST)\nON ROWS\nFROM Sample.Basic"
  },
  "links" : [ {
    "rel" : "self",
    "method" : "GET"
  }, {
    "rel" : "delete",
    "method" : "DELETE"
  }, {
    "rel" : "update",
    "method" : "PUT"
  }, {
    "rel" : "Get data In JSON",
    "method" : "GET"
  }, {
    "rel" : "Get data in HTML",
    "href" : "?format=HTML",
    "method" : "GET"
  }, {
    "rel" : "Get data in Excel",
    "href" : "?format=XLSX",
    "method" : "GET"
  }, {
    "rel" : "Get data in CSV",
    "href" : "?format=CSV",
    "method" : "GET"
  } ]
}