Jump to

• Request
• Response
• Examples

Delete Location Alias

delete

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

Deletes the specified location alias from the application and database.

Request

Path Parameters

• aliasName(required): string

  Location alias name.

• applicationName(required): string

  Application name.

• databaseName(required): string

  Database name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

204 Response

OK

Location alias deleted successfully.

400 Response

Bad Request

Failed to delete location alias.

500 Response

Internal Server Error.

Back to Top

Examples

The following example shows how remove a location alias 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

The following script drops the location alias named EasternDB from Sample Basic.

call properties.bat
curl -X DELETE "https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/locationaliases/EasternDB?links=none" -H "Accept:application/json" -u %User%:%Password%

Example of Response Body

A response is returned if there is an error; for example,

{
  "errorMessage" : "Location alias EasternDB not found -- delete failed",
  "errorCode" : 1023067
}

Back to Top