REST API for Oracle Essbase

Rename Database

post

/essbase/rest/v1/applications/{applicationName}/databases/actions/rename

Renames a database. You must provide the source application name, and the source and destination database names. Destination application name is not required.

Request

Supported Media Types

application/json
application/xml

Path Parameters

applicationName(required): string

Source application name.

Source and destination database information.

Root Schema : CopyRenameBean

Type: object

Show Source

from(required): string
to(required): string

{
    "type":"object",
    "required":[
        "from",
        "to"
    ],
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Database renamed successfully.

400 Response

Bad Request

Failed to rename database.

500 Response

Internal Server Error.

Examples

The following example shows how to rename a database (cube) using the Essbase REST API.

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

Supply the source application name as a path parameter, and the source and destination cube names in the body.

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/MyApp/databases/actions/rename -H "Accept: application/json" -H "Content-Type: application/json" -d '{"from": "Basic", "to": "MyBasic"}' -u %User%:%Password%

Example of Response

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

{
  "errorMessage" : "Database \"Basic\" does not exist.",
  "errorCode" : 1051032
}