REST API for Oracle Essbase

Get Drill Through Reports

get

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

Returns all the drill through reports from the specified application and database.

Request

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Query Parameters

keyword: string

Filter the list of drill-through reports using a keyword.

Response

Supported Media Types

application/json
application/xml

200 Response

The drill through reports were retrieved successfully. Returns the links to get, edit, or delete the reports.

Root Schema : schema

Type: array

Show Source

Array of: object ReportList

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

Nested Schema : ReportList

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":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReportBean"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object ReportBean

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

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

Nested Schema : ReportBean

Type: object

Show Source

links: array links
locked: boolean
lockedBy: string
lockedTime: integer(int64)
modifiedTime: integer(int64)
name: string
sizeInBytes: integer(int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "lockedTime":{
            "type":"integer",
            "format":"int64"
        },
        "locked":{
            "type":"boolean"
        },
        "modifiedTime":{
            "type":"integer",
            "format":"int64"
        },
        "sizeInBytes":{
            "type":"integer",
            "format":"int64"
        },
        "lockedBy":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

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 the drill through reports. The application or database name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to get a list of all drill through reports in the 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/SampleDtr/databases/Basic/reports" -H Accept:application/json -H Content-Type:application/octet-stream -u %User%:%Password%

Example of Response Body

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

{
  "items" : [ {
    "name" : "sampleDtr",
    "modifiedTime" : 1660068656087,
    "sizeInBytes" : 565,
    "links" : [ {
      "rel" : "get",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/sampleDtr",
      "method" : "GET"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/sampleDtr",
      "method" : "DELETE"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/sampleDtr",
      "method" : "PUT"
    } ]
  }, {
    "name" : "drill2",
    "modifiedTime" : 1660076664087,
    "sizeInBytes" : 912,
    "links" : [ {
      "rel" : "get",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2",
      "method" : "GET"
    }, {
      "rel" : "delete",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2",
      "method" : "DELETE"
    }, {
      "rel" : "edit",
      "href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/SampleDtr/databases/Basic/reports/drill2",
      "method" : "PUT"
    } ]
  } ],
  "totalResults" : 2,
  "count" : 2
}