Jump to

• Request
• Response

Get MDX Report Details

get

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

Get the details for the specified MDX report.

Request

Path Parameters

• application: string

  Application name.

• database: string

  Database name.

• query: string

  MDX report name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

MDX report details returned successfully.

Body ()

Root Schema : NamedQuery

Type: object

Show Source

• name(optional): string
• query(optional): object Query
• type(optional): 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(optional): string
• preferences(optional): object NamedQueriesPreferences
• spec(optional): string

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

Nested Schema : NamedQueriesPreferences

Type: object

Show Source

• cellAttributes(optional): boolean
• dataless(optional): boolean

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

• formatString(optional): 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(optional): boolean
• hideRestrictedData(optional): boolean
• meaninglessCells(optional): boolean
• memberIdentifierType(optional): 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(optional): boolean
• urlDrillThrough(optional): 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.

Back to Top