Jump to

• Request
• Response
• Examples

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: string

  Application name.

• databaseName: string

  Database name.

Query Parameters

• applicationNameForConnection(optional): string

  Application name for connection.

• connectionName(optional): string

  Essbase connection name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Attribute settings returned successfully.

Body ()

Root Schema : attributes

Type: object

Show Source

• calcAverageMember(optional): string
• calcCountMember(optional): string
• calcDimensionName(optional): string
• calcMaximumMember(optional): string
• calcMinimumMember(optional): string
• calcSumMember(optional): string
• dateMemberNames(optional): string
• falseMemberName(optional): string
• numericRangesRepresent(optional): string
• prefixSuffixFormat(optional): string
• prefixSuffixSeparator(optional): string
• prefixSuffixValue(optional): string
• trueMemberName(optional): string

{
    "type":"object",
    "properties":{
        "prefixSuffixValue":{
            "type":"string"
        },
        "prefixSuffixSeparator":{
            "type":"string"
        },
        "prefixSuffixFormat":{
            "type":"string"
        },
        "trueMemberName":{
            "type":"string"
        },
        "falseMemberName":{
            "type":"string"
        },
        "dateMemberNames":{
            "type":"string"
        },
        "numericRangesRepresent":{
            "type":"string"
        },
        "calcDimensionName":{
            "type":"string"
        },
        "calcSumMember":{
            "type":"string"
        },
        "calcCountMember":{
            "type":"string"
        },
        "calcMinimumMember":{
            "type":"string"
        },
        "calcMaximumMember":{
            "type":"string"
        },
        "calcAverageMember":{
            "type":"string"
        }
    },
    "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.

Back to Top

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"
  }
}

Back to Top