1. REST API for Oracle Essbase
  2. Tasks
  3. Applications

List Application Names

get

/essbase/rest/v1/applications/actions/name/{appVisiblity}

Returns the list of application names, based on the type of visibility requested. For example, you can fetch the list of hidden (shadow) applications only, or you can fetch the visible applications list only, or both sets of applications.

Request

Path Parameters

  • appVisiblity : Visibility level of application names. Valid options: ALL, HIDDEN, REGULAR

    Allowed Values: [ "ALL", "HIDDEN", "REGULAR" ]
Back to Top

Response

Supported Media Types

200 Response

OK

Application names returned successfully.

Body ()
Root Schema : Arrays
Type: object

400 Response

Bad Request

Failed to get application names.

500 Response

Internal Server Error.

503 Response

Service Unavailable

Naming exception or server exception.

Back to Top

Examples

The following example shows how to list application names.

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

In this example, ALL is used to indicate that both base applications and hidden shadow applications (if they exist) should be included in the response.

call properties.bat
curl -X GET "https://myserver.example.com:9001/essbase/rest/v1/applications/actions/name/ALL" -H "accept: application/json" -u %User%:%Password%

Example of Response Body

[
  "Sample_Dynamic",
  "SDShadow"
]
Back to Top