Jump to

• Request
• Response
• Examples

Get Outline Settings

get

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

Returns outline settings of the specified database. Additional settings can be retrieved using the expand parameter.

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.

• expand: string

  Use none to show only general outline settings (this is the default). Other options available are attribute and all.

  Default Value: none

  Allowed Values: [ "none", "attributes", "all" ]

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Database outline settings returned successfully, with links to get expanded settings.

Body ()

Root Schema : outlineSettings

Type: object

Show Source

• attributes: object attributes

  Specifications for handling member names in attribute dimensions.

• general: object general
• links: array links

{
    "type":"object",
    "properties":{
        "general":{
            "$ref":"#/definitions/GeneralOutlineSettings"
        },
        "attributes":{
            "$ref":"#/definitions/AttributeOutlineSettings"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"outlineSettings"
    }
}

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

Nested Schema : general

Type: object

Show Source

• allowDuplicateMemberNames: boolean

  true if duplicate member names were enabled at outline creation time, and false otherwise (member names must be unique).

• caseSensitiveMembers: boolean
• dateFormat: string

  Date format displayed in queries on date measures (if typed measures are enabled and date measures are implemented). For example: mm/dd/yyyy. Refer to otlUpdate action in Run Batch Outline Edit.

• outlineType: string
• timeModified: integer(int64)
• typeMeasuresEnabled: boolean

  true if typed measures are enabled, and false otherwise. The default is true. Typed measures include date measures and text lists. Both of these extend the capabilities of Essbase beyond numerical data to text- and date-based analytics.

• varyingAttributesEnabled: boolean

{
    "type":"object",
    "properties":{
        "caseSensitiveMembers":{
            "type":"boolean"
        },
        "outlineType":{
            "type":"string"
        },
        "allowDuplicateMemberNames":{
            "type":"boolean",
            "description":"<p><code>true</code> if duplicate member names were enabled at outline creation time, and  <code>false</code> otherwise (member names must be unique).</p>"
        },
        "typeMeasuresEnabled":{
            "type":"boolean",
            "description":"<p><code>true</code> if typed measures are enabled, and <code>false</code> otherwise. The default is true. Typed measures include date measures and text lists. Both of these extend the capabilities of Essbase beyond numerical data to text- and date-based analytics.</p>"
        },
        "dateFormat":{
            "type":"string",
            "description":"<p>Date format displayed in queries on date measures (if typed measures are enabled and date measures are implemented). For example: <code>mm/dd/yyyy</code>. Refer to <b>otlUpdate</b> action in <a href=\"./op-applications-application-databases-database-boe-post.html\">Run Batch Outline Edit</a>.</p>"
        },
        "varyingAttributesEnabled":{
            "type":"boolean"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        }
    },
    "xml":{
        "name":"general"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get the 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 outline 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?expand=all" -H "accept: application/json"-u %User%:%Password%

Example of Response Body

{
  "general": {
    "caseSensitiveMembers": false,
    "outlineType": "NORMAL",
    "allowDuplicateMemberNames": false,
    "typeMeasuresEnabled": true,
    "dateFormat": "yyyy-mm-dd",
    "varyingAttributesEnabled": false,
    "timeModified": 1586286662000
  },
  "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"
  },
  "links": [
    {
      "rel": "dateformats",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/outline/dateformats",
      "method": "GET"
    },
    {
      "rel": "edit",
      "href": "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample_Dynamic/databases/Basic/settings/outline",
      "method": "PATCH"
    }
  ]
}

Back to Top