Jump to

• Request
• Response
• Examples

Get Location Aliases

get

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/locationaliases

Gets details about location aliases defined on the database.

Request

Path Parameters

• applicationName(required): string

  Application name.

• databaseName(required): string

  Database name.

Query Parameters

• applicationName: string

  Location alias target application name.

• databaseName: string

  Location alias target database name.

• limit: integer(int32)

  Maximum number of location aliases to return.

• offset: integer(int32)

  Number of items to omit from the start of the result set.

• serverName: string

  Location alias target server name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Location aliases returned successfully.

Body ()

Root Schema : LocationAliasList

Type: object

Show Source

• count: integer(int64)
• hasMore: boolean
• items: array items
• limit: integer(int64)
• links: array links
• offset: integer(int64)
• properties: object properties
  Additional Properties Allowed: additionalProperties
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LocationAliasBean"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object LocationAliasBean

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LocationAliasBean"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : LocationAliasBean

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "aliasName":{
            "type":"string",
            "description":"<p>Name of the location alias.</p>"
        },
        "connectionName":{
            "type":"string",
            "description":"<p>If the location alias is based on a saved connection, the name of the connection.</p>"
        },
        "serverName":{
            "type":"string",
            "description":"<p>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.</p>"
        },
        "userName":{
            "type":"string",
            "description":"<p>If the location alias is not based on a saved connection, the name of a user who is authorized to log in to <i>serverName</i>. Optional if both cubes are on the same Essbase Server.</p>"
        },
        "applicationName":{
            "type":"string",
            "description":"<p>Application name for the database/cube to which the location alias refers.</p>"
        },
        "databaseName":{
            "type":"string",
            "description":"<p>Name of the database to which the location alias refers.</p>"
        },
        "applicationLevelConnection":{
            "type":"boolean",
            "description":"<p>If the location alias is based on a saved connection, this parameter should be <b>true</b> if the connection is application-level, or <b>false</b> if the connection is globally defined.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get location alias details.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how retrieve information about location aliases defined on the Essbase database (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?links=none" -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

{
  "items" : [ {
    "aliasName" : "EasternDB",
    "serverName" : "https://myserver.example.com:9001/essbase/agent",
    "userName" : "",
    "applicationName" : "Eastern",
    "databaseName" : "Sales",
    "applicationLevelConnection" : false
  } ],
  "totalResults" : 1,
  "limit" : 1,
  "count" : 1
}

Back to Top