REST API for Oracle Essbase

Get Attribute Settings

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/settings/outline/attributes

Returns attribute settings of the outline from the specified database.

Request

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Query Parameters

applicationNameForConnection: string

Application name for connection.
connectionName: string

Essbase connection name.

Response

Supported Media Types

application/json
application/xml

200 Response

Attribute settings returned successfully.

Root Schema : attributes

Type: object

Specifications for handling member names in attribute dimensions.

Show Source

calcAverageMember: string

In an attribute calculations dimension, the name to use when requesting average data.
calcCountMember: string

In an attribute calculations dimension, the name to use when requesting count data.
calcDimensionName: string

The name of the attribute calculations dimension.
calcMaximumMember: string

In an attribute calculations dimension, the name to use when requesting maximum data.
calcMinimumMember: string

In an attribute calculations dimension, the name to use when requesting minimum data.
calcSumMember: string

In an attribute calculations dimension, the name to use when requesting sum data.
dateMemberNames: string

Date member format in attribute dimensions. Values: MMDDYYYY for Month first or DDMMYYYY for day first.
falseMemberName: string

Name for False members in Boolean attribute dimensions.
numericRangesRepresent: string

Date range setting for numeric attribute dimensions. Values: UPPER_BOUND_INCLUSIVE, LOWER_BOUND_INCLUSIVE, UPPER_BOUND_NON_INCLUSIVE, LOWER_BOUND_NON_INCLUSIVE
prefixSuffixFormat: string

If unique names are required for member names in Boolean, date, and numeric attribute dimensions in the outline, set prefixSuffixValue to something other than NONE and set this value to select a prefix or a suffix. Values: PREFIX or SUFFIX.
prefixSuffixSeparator: string

Separator character between the prefix or suffix and the attribute member name. Values: UNDERSCORE, PIPE, CARET
prefixSuffixValue: string

A prefix or suffix value to use for attribute member names as needed to support member name uniqueness.
Values: NONE, PARENT, GRANDANDPARENT, ALLANCESTORS, DIMENSION
trueMemberName: string

Name for True members in Boolean attribute dimensions.

{
    "type":"object",
    "description":"<p>Specifications for handling member names in attribute dimensions.</p>",
    "properties":{
        "prefixSuffixValue":{
            "type":"string",
            "description":"A prefix or suffix value to use for attribute member names as needed to support member name uniqueness. <p>Values: <code>NONE</code>, <code>PARENT</code>, <code>GRANDANDPARENT</code>, <code>ALLANCESTORS</code>, <code>DIMENSION</code></p>"
        },
        "prefixSuffixSeparator":{
            "type":"string",
            "description":"<p>Separator character between the prefix or suffix and the attribute member name. Values: <code>UNDERSCORE</code>, <code>PIPE</code>, <code>CARET</code></p>"
        },
        "prefixSuffixFormat":{
            "type":"string",
            "description":"<p>If unique names are required for member names in Boolean, date, and numeric attribute dimensions in the outline, set <i>prefixSuffixValue</i> to something other than NONE and set this value to select a prefix or a suffix. Values: <code>PREFIX</code> or <code>SUFFIX</code>.</p>"
        },
        "trueMemberName":{
            "type":"string",
            "description":"<p>Name for True members in Boolean attribute dimensions.</p>"
        },
        "falseMemberName":{
            "type":"string",
            "description":"<p>Name for False members in Boolean attribute dimensions.</p>"
        },
        "dateMemberNames":{
            "type":"string",
            "description":"<p>Date member format in attribute dimensions. Values: <code>MMDDYYYY</code> for Month first or <code>DDMMYYYY</code> for day first.</p>"
        },
        "numericRangesRepresent":{
            "type":"string",
            "description":"<p>Date range setting for numeric attribute dimensions. Values: <code>UPPER_BOUND_INCLUSIVE</code>, <code>LOWER_BOUND_INCLUSIVE</code>, <code>UPPER_BOUND_NON_INCLUSIVE</code>, <code>LOWER_BOUND_NON_INCLUSIVE</code> </p>"
        },
        "calcDimensionName":{
            "type":"string",
            "description":"<p>The name of the attribute calculations dimension.</p>"
        },
        "calcSumMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting sum data.</p>"
        },
        "calcCountMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting count data.</p>"
        },
        "calcMinimumMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting minimum data.</p>"
        },
        "calcMaximumMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting maximum data.</p>"
        },
        "calcAverageMember":{
            "type":"string",
            "description":"<p>In an attribute calculations dimension, the name to use when requesting average data.</p>"
        }
    },
    "xml":{
        "name":"attributes"
    }
}

400 Response

Bad Request

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

500 Response

Internal Server Error.

Examples

The following example shows how to get attribute 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/outline/attributes" -H "accept: application/json"-u %User%:%Password%

Example of Response Body

{
  "attributes": {
    "prefixSuffixValue": "Parent",
    "prefixSuffixSeparator": "Underscore",
    "prefixSuffixFormat": "Prefix",
    "trueMemberName": "True",
    "falseMemberName": "False",
    "dateMemberNames": "Month First (mm-dd-yyyy)",
    "numericRangesRepresent": "Upper bound inclusive",
    "calcDimensionName": "Attribute Calculations",
    "calcSumMember": "Sum",
    "calcCountMember": "Count",
    "calcMinimumMember": "Min",
    "calcMaximumMember": "Max",
    "calcAverageMember": "Avg"
  }
}