Jump to

• Request
• Response

Get Location Alias

get

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

Returns details of the specified location alias.

Request

Path Parameters

• aliasName: string

  Location alias name.

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Location alias returned successfully.

Body ()

Root Schema : LocationAliasBean

Type: object

Show Source

• aliasName(optional): string
• applicationLevelConnection(optional): boolean
• applicationName(optional): string
• connectionName(optional): string
• databaseName(optional): string
• links(optional): array links
• serverName(optional): string
• userName(optional): string

{
    "type":"object",
    "properties":{
        "aliasName":{
            "type":"string"
        },
        "connectionName":{
            "type":"string"
        },
        "serverName":{
            "type":"string"
        },
        "userName":{
            "type":"string"
        },
        "applicationName":{
            "type":"string"
        },
        "databaseName":{
            "type":"string"
        },
        "applicationLevelConnection":{
            "type":"boolean"
        },
        "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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): 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