Jump to

• Request
• Response

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: string

  Application name.

• databaseName: string

  Database name.

Query Parameters

• applicationName(optional): string

  Location alias target application name.

• databaseName(optional): string

  Location alias target database name.

• limit(optional): integer(int32)

  Maximum number of location aliases to return.

• offset(optional): integer(int32)

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

• serverName(optional): 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(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• links(optional): array links
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): 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(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