REST API for Oracle Essbase

Copy Calc Script

post

/essbase/rest/v1/applications/{applicationName}/databases/{databaseName}/scripts/scriptops/copy

Copies the script in the specified application and database and returns the created script. Applicable only for calculation scripts.

Request

Supported Media Types

application/json
application/xml

Path Parameters

applicationName(required): string

Application name.
databaseName(required): string

Database name.

Script copy details.

Root Schema : ScriptCopy

Type: object

Show Source

from(required): string

Script's original name.
to(required): string

Script's new name.

{
    "type":"object",
    "required":[
        "from",
        "to"
    ],
    "properties":{
        "from":{
            "type":"string",
            "description":"<p>Script's original name.</p>"
        },
        "to":{
            "type":"string",
            "description":"<p>Script's new name.</p>"
        }
    }
}

Response

Supported Media Types

application/json
application/xml

200 Response

Script copied successfully, including script details and links to get, edit, or delete the script and to get its contents.

Root Schema : Script

Type: object

Show Source

content: string

Script contents.
links: array links
locked: boolean
lockedBy: string
lockedTime: integer(int64)
modifiedTime: integer(int64)
name: string

Script name.
sizeInBytes: integer(int64)

{
    "type":"object",
    "properties":{
        "content":{
            "type":"string",
            "description":"<p>Script contents.</p>"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "lockedTime":{
            "type":"integer",
            "format":"int64"
        },
        "locked":{
            "type":"boolean"
        },
        "modifiedTime":{
            "type":"integer",
            "format":"int64"
        },
        "sizeInBytes":{
            "type":"integer",
            "format":"int64"
        },
        "lockedBy":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"<p>Script name.</p>"
        }
    }
}

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: string
method: string
rel: string
type: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to copy the script. The application, database, or script name may be incorrect, or the specified script name may already exist.

415 Response

Not Acceptable

The media type isn't supported or wasn't specified.

500 Response

Internal Server Error.

Examples

The following example shows how to copy an Essbase calculation script.

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

call properties.bat
curl -X POST "https://myserver.example.com:9001/essbase/rest/v1/applications/CalcTuple/databases/Tuple/scripts/scriptops/copy?links=none" -H "Accept: application/json" -H "Content-Type:application/json" -d '{"from": "svProductMarketTuples", "to": "svProductMarketTuplesNew" }' -u %User%:%Password%

Example of Response Body

{
  "name" : "svProductMarketTuplesNew",
  "modifiedTime" : 1718724319362,
  "sizeInBytes" : 93
}