REST API for Oracle Essbase

Get Compression Settings

get

/applications/{applicationName}/databases/{databaseName}/settings/compression

Returns compression settings of the specified database.

Request

Path Parameters

applicationName(required):

Application name.
databaseName(required):

Database name.

Response

200 Response

Compression settings retrieved successfully.

400 Response

Bad Request

Failed to get the compression settings. The application or database name may be incorrect.

500 Response

Internal Server Error.

Examples

The following example shows how to get compression settings for a 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/ASOSamp/databases/Basic/settings/compression" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "compression": [
    {
      "dimensionName": "<No Compression Dimension>",
      "isCompression": false,
      "storedLevel0Members": 0,
      "averageBundleFill": 1,
      "averageValueLength": 8,
      "level0MB": 19.071334838867188
    },
    {
      "dimensionName": "Measures",
      "isCompression": true,
      "storedLevel0Members": 5,
      "averageBundleFill": 4.011231448054553,
      "averageValueLength": 2.418,
      "level0MB": 6.448018309020995
    },
    {
      "dimensionName": "Years",
      "isCompression": false,
      "storedLevel0Members": 2,
      "averageBundleFill": 1.0060362173038229,
      "averageValueLength": 2.22,
      "level0MB": 16.863827831268313
    },
    {
      "dimensionName": "Time",
      "isCompression": false,
      "storedLevel0Members": 12,
      "averageBundleFill": 1.0836081053886284,
      "averageValueLength": 2.23,
      "level0MB": 15.857951142338342
    },
    {
      "dimensionName": "Transaction Type",
      "isCompression": false,
      "storedLevel0Members": 3,
      "averageBundleFill": 1.002004008016032,
      "averageValueLength": 2.22,
      "level0MB": 16.921041835784912
    },
    {
      "dimensionName": "Payment Type",
      "isCompression": false,
      "storedLevel0Members": 4,
      "averageBundleFill": 1.0111223458038423,
      "averageValueLength": 2.22,
      "level0MB": 16.79231032562256
    },
    {
      "dimensionName": "Promotions",
      "isCompression": false,
      "storedLevel0Members": 5,
      "averageBundleFill": 1.0015022533800702,
      "averageValueLength": 2.22,
      "level0MB": 16.928193586349487
    },
    {
      "dimensionName": "Age",
      "isCompression": false,
      "storedLevel0Members": 9,
      "averageBundleFill": 1.0167768174885612,
      "averageValueLength": 2.22,
      "level0MB": 16.713641069412233
    },
    {
      "dimensionName": "Income Level",
      "isCompression": false,
      "storedLevel0Members": 6,
      "averageBundleFill": 1.010611419909045,
      "averageValueLength": 2.22,
      "level0MB": 16.799462076187133
    },
    {
      "dimensionName": "Products",
      "isCompression": false,
      "storedLevel0Members": 25,
      "averageBundleFill": 1.0429341213280028,
      "averageValueLength": 2.232,
      "level0MB": 16.375124876022337
    },
    {
      "dimensionName": "Stores",
      "isCompression": false,
      "storedLevel0Members": 239,
      "averageBundleFill": 1,
      "averageValueLength": 2.22,
      "level0MB": 16.949648838043213
    },
    {
      "dimensionName": "Geography",
      "isCompression": false,
      "storedLevel0Members": 9398,
      "averageBundleFill": 1.0310164103445314,
      "averageValueLength": 2.23,
      "level0MB": 16.531271430015565
    }
  ]
}