Jump to

• Request
• Response
• Examples

Get Text Lists

get

/essbase/rest/v1/outline/{app}/{cube}/settings/smartlist

Returns all text lists associated with the database outline.

Request

Path Parameters

• app: string

  Application name.

• cube: string

  Database name.

Query Parameters

• applicationNameForConnection(optional): string

  Application name for connection.

• connection(optional): string

  Essbase connection name.

Header Parameters

• accept(optional): string
  Default Value: application/json

Back to Top

Response

Supported Media Types

• application/json
• application/xml

Default Response

OK

Text lists returned.

Back to Top

Examples

The following example shows how to get the text lists (smart lists) associated with an Essbase cube outline.

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/outline/Facility/Rating/settings/smartlist?links=none" -H Accept:application/json -H Content-Type:application/json -o output.json -u %User%:%Password%

Example of Response Body

The following information is written to output.json:

{
	"ResponseValues": {
		"#Missing": "Blank",
		"#OutOfRange": "N/A",
		"1": "Perfect",
		"2": "Very Nice",
		"3": "Nice",
		"4": "Good some of the times",
		"5": "No Opinion",
		"6": "Mangeable",
		"7": "Needs Improvement",
		"8": "Bad",
		"9": "Very Bad",
		"10": "Not Usable"
	}
}

Back to Top