Get Location Alias
/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/locationaliases/{aliasName}
Returns details of the specified location alias.
Request
-
aliasName(required): string
Location alias name.
-
applicationName(required): string
Application name.
-
databaseName(required): string
Database name.
Response
- application/json
- application/xml
200 Response
OK
Location alias returned successfully.
object
-
aliasName:
string
Name of the location alias.
-
applicationLevelConnection:
boolean
If the location alias is based on a saved connection, this parameter should be true if the connection is application-level, or false if the connection is globally defined.
-
applicationName:
string
Application name for the database/cube to which the location alias refers.
-
connectionName:
string
If the location alias is based on a saved connection, the name of the connection.
-
databaseName:
string
Name of the database to which the location alias refers.
-
links:
array links
-
serverName:
string
If the location alias is not based on a saved connection, the Essbase Server host name of the database/cube to which the location alias refers.
-
userName:
string
If the location alias is not based on a saved connection, the name of a user who is authorized to log in to serverName. Optional if both cubes are on the same Essbase Server.
400 Response
Bad Request
Failed to get location alias details.
500 Response
Internal Server Error.
Examples
The following example shows how retrieve information about a named location alias defined on an Essbase 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/databases/Basic/locationaliases/EasternDB -H "Accept:application/json" -u %User%:%Password%
Example of Response Body
{
"aliasName" : "EasternDB",
"serverName" : "https://myserver.example.com:9001/essbase/agent",
"userName" : "",
"applicationName" : "Eastern",
"databaseName" : "Sales",
"applicationLevelConnection" : false,
"links" : [ {
"rel" : "canonical",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locationaliases/EasternDB",
"method" : "GET",
"type" : "application/json"
}, {
"rel" : "update",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locationaliases/EasternDB",
"method" : "PATCH",
"type" : "application/json"
}, {
"rel" : "delete",
"href" : "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locationaliases/EasternDB",
"method" : "DELETE",
"type" : "application/json"
} ]
}