List Databases
/essbase/rest/v1/applications/{applicationName}/databases
Returns list of databases. Providing the connection name for which to list databases is optional. If a connection name is provided, connections created at the specified application is used to fetch the database list.
Request
-
applicationName: string
Application name.
-
applicationNameForConnection(optional): string
Application name from which to list databases.
-
connectionName(optional): string
Connection name.
Response
- application/json
- application/xml
200 Response
OK
Database list returned successfully.
object
-
application(optional):
string
-
applicationRole(optional):
string
-
creationTime(optional):
integer(int64)
-
description(optional):
string
-
easManagedApp(optional):
boolean
If true, the application is managed in Essbase Administration Services (EAS) Lite instead of the Essbase web interface. EAS Lite is available as a limited-option alternative available only for Essbase 21c independent deployment.
-
inspectDBAllowed(optional):
boolean
-
links(optional):
array links
-
modifiedBy(optional):
string
-
modifiedTime(optional):
integer(int64)
-
name(optional):
string
-
owner(optional):
string
-
startStopDBAllowed(optional):
boolean
-
startTime(optional):
integer(int64)
-
status(optional):
string
-
type(optional):
string
Allowed Values:
[ "ASO", "BSO", "CURRENCY" ]
400 Response
Bad Request
Failed to get databases.
500 Response
Internal Server Error.
Examples
The following example shows how to get a list of Essbase databases.
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/databases?links=none" -H Accept:application/json -H Content-Type:application/json -u %User%:%Password%
Example of Response Body
{
"items" : [ {
"name" : "Basic",
"application" : "Sample",
"owner" : "admin",
"creationTime" : 1663198643123,
"status" : "started",
"startTime" : 1663814542677,
"type" : "BSO",
"description" : "",
"modifiedBy" : "admin",
"modifiedTime" : 1663814710916,
"applicationRole" : "app_manager",
"startStopDBAllowed" : true,
"inspectDBAllowed" : true,
"dbVariablesSetting" : {
"showVariables" : true,
"updateVariables" : true
}
} ]
}