REST API for Oracle Essbase

List MDX Reports

get

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

List all the saved MDX reports for the specified cube.

An MDX report is saved in the cube context.

Request

Path Parameters

application(required): string

Application name.
database(required): string

Database name.

Response

Supported Media Types

application/json
application/xml

200 Response

List of MDX reports returned successfully.

Root Schema : Queries

Type: object

Show Source

count: integer(int64)
hasMore: boolean
items: array items
limit: integer(int64)
offset: integer(int64)
properties: object properties

Additional Properties Allowed: additionalProperties
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/QueryMetadata"
            }
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object QueryMetadata

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/QueryMetadata"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : QueryMetadata

Type: object

Show Source

links: array links
name: string
type: string

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

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string",
            "enum":[
                "MDX",
                "DATA_SOURCE"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

href: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get MDX reports.

Examples

The following example shows how to retrieve the list of saved MDX reports associated with 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?links=none" -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

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

{
  "items" : [ {
    "name" : "closingperiod",
    "type" : "MDX"
  }, {
    "name" : "count",
    "type" : "MDX"
  }, {
    "name" : "lastperiods",
    "type" : "MDX"
  }, {
    "name" : "mdxreport05",
    "type" : "MDX"
  }, {
    "name" : "remainder",
    "type" : "MDX"
  }, {
    "name" : "value",
    "type" : "MDX"
  } ],
  "count" : 6,
  "totalResults" : 6
}