REST API for Oracle Essbase

Get Database Size Statistics

get

/essbase/rest/v1/databasesizestatistics

Returns a list of block storage databases and their page and index sizes.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json
application/xml

200 Response

Database size statistics returned successfully.

Root Schema : DBSizeList

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/DatabaseSizeStatistics"
            }
        },
        "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 DatabaseSizeStatistics

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

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

Nested Schema : DatabaseSizeStatistics

Type: object

Show Source

indexSize: integer(int64)
name: string
pageSize: integer(int64)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "pageSize":{
            "type":"integer",
            "format":"int64"
        },
        "indexSize":{
            "type":"integer",
            "format":"int64"
        }
    }
}

400 Response

Bad Request

Failed to get database size statistics.

500 Response

Internal Server Error.

Examples

The following example shows how to retrieve a list of all the block storage cubes on the Essbase Server, including their sizes.

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/databasesizestatistics -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

{
  "items" : [ {
    "name" : "Sample.Basic",
    "pageSize" : 884790,
    "indexSize" : 8216576
  }, {
    "name" : "Demo.Basic",
    "pageSize" : 811060,
    "indexSize" : 8216576
  }, {
    "name" : "Sample_RTSV.Basic",
    "pageSize" : 294971,
    "indexSize" : 8216576
  }, {
    "name" : "Sample_Dynamic.Basic",
    "pageSize" : 294974,
    "indexSize" : 8216576
  }, {
    "name" : "Sample_Currency.Interntl",
    "pageSize" : 7372866,
    "indexSize" : 8216576
  }, {
    "name" : "Sample_Currency.Xchgrate",
    "pageSize" : 49218,
    "indexSize" : 8216576
  } ],
  "count" : 6,
  "totalResults" : 6
}