REST API for Oracle Essbase

Get Calculation Settings

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/calculation

Returns calculation settings of the specified database.

Request

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Response

Supported Media Types

application/json
application/xml

200 Response

Calculation settings retrieved successfully.

Root Schema : calculation

Type: object

Show Source

aggregateMissingValues: boolean

If true, aggregate #MISSING values along with the regular cube consolidation. The default is false (missing values are not aggregated).
createBlocksOnEquations: boolean

Force creation of data blocks on constant assignment calc equations (only valid for sparse dimensions). If true, blocks are created.
twoPassCalculation: boolean

Force two pass calculation when running a full calculation (true if two pass calculation is enabled)

{
    "type":"object",
    "properties":{
        "aggregateMissingValues":{
            "type":"boolean",
            "description":"<p>If <b>true</b>, aggregate #MISSING values along with the regular cube consolidation. The default is false (missing values are not aggregated).</p>"
        },
        "createBlocksOnEquations":{
            "type":"boolean",
            "description":"<p>Force creation of data blocks on constant assignment calc equations (only valid for sparse dimensions). If true, blocks are created.</p>"
        },
        "twoPassCalculation":{
            "type":"boolean",
            "description":"<p>Force two pass calculation when running a full calculation (<b>true</b> if two pass calculation is enabled)</p>"
        }
    },
    "xml":{
        "name":"calculation"
    }
}

400 Response

Bad Request

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

500 Response

Internal Server Error.

Examples

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

Example of Response Body

{
  "calculation": {
    "aggregateMissingValues": false,
    "createBlocksOnEquations": false,
    "twoPassCalculation": false
  }
}