Get Application
/essbase/rest/v1/applications/{applicationName}
Returns details of application with specified name.
Request
-
applicationName(required): string
Application name.
-
role: boolean
Role.
Default Value:false
Response
- application/json
- application/xml
200 Response
OK
Application details returned successfully.
object
-
connectedUsersCount:
integer(int32)
The number of users currently connected to the application.
-
creationTime:
integer(int64)
-
description:
string
-
easManagedApp:
boolean
If true, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. Before you can connect to an application in EAS Lite, you must set it as an EAS managed application. The Essbase web interface is the modern administration interface that supports all current platform features, but EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.
-
inspectAppAllowed:
boolean
-
links:
array links
-
modifiedBy:
string
-
modifiedTime:
integer(int64)
-
name:
string
-
owner:
string
-
role:
string
-
startStopAppAllowed:
boolean
true if users who have at least read permission can start the application.
-
startTime:
integer(int64)
-
status:
string
-
type:
string
Allowed Values:
[ "ASO", "BSO", "CURRENCY" ]
400 Response
Bad Request
Failed to get application.
500 Response
Internal Server Error.
Examples
The following example shows how to get information about an Essbase application.
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/Facility?links=none" -H "Accept:application/json" -H "Content-Type:application/json" -u %User%:%Password%
Example of Response Body
{
"name" : "Facility",
"owner" : "admin",
"creationTime" : 1661570700487,
"status" : "stopped",
"type" : "BSO",
"connectedUsersCount" : 0,
"description" : "",
"modifiedBy" : "admin",
"modifiedTime" : 1661570700487,
"startStopAppAllowed" : true,
"inspectAppAllowed" : true,
"appVariablesSetting" : {
"showVariables" : true,
"updateVariables" : true
}
}