REST API for Oracle Essbase

Copy Database

post

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

Copies an Essbase database (cube). You must provide the source and destination application and cube names. This operation is supported only for block storage cubes.

Request

Supported Media Types

application/json
application/xml

Path Parameters

applicationName(required): string

Source application name.

Source and destination database information.

Root Schema : CubeCopy

Type: object

Show Source

from(required): string
to(required): object To

{
    "type":"object",
    "required":[
        "from",
        "to"
    ],
    "properties":{
        "from":{
            "type":"string"
        },
        "to":{
            "$ref":"#/definitions/To"
        }
    }
}

Nested Schema : To

Type: object

Show Source

application: string
database(required): string

{
    "type":"object",
    "required":[
        "database"
    ],
    "properties":{
        "database":{
            "type":"string"
        },
        "application":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Database copied successfully.

400 Response

Bad Request

Failed to copy database.

500 Response

Internal Server Error.

Examples

The following example shows how to copy 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

Specifying an application in the to: specification can be omitted if you are copying the cube within the same application.

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

Example of Response

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

{
  "errorMessage" : "Operation not supported for aggregate storage applications",
  "errorCode" : 1013292
}