Get Outline Settings
/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
-
applicationName: string
Application name.
-
databaseName: string
Database name.
-
applicationNameForConnection(optional): string
Application name for connection.
-
connectionName(optional): string
Essbase connection name.
-
expand(optional): string
Use
none
to show only general outline settings (this is the default). Other options available areattribute
andall
.Default Value:none
Allowed Values:[ "none", "attributes", "all" ]
Response
- application/json
- application/xml
200 Response
OK
Database outline settings returned successfully, with links to get expanded settings.
object
-
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
400 Response
Bad Request
Failed to get the settings. The application or database name may be incorrect.
500 Response
Internal Server Error.
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"
}
]
}