REST API for Oracle Essbase

Validate Calc Script

post

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

Validates the specified 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.

Query Parameters

file: string

File.

Default Value: calc

Script details.

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"
        }
    }
}

Response

200 Response

Script validated successfully.

400 Response

Bad Request

Failed to validate the script. The application or database name may be incorrect, or the contents may be incomplete for the specified script name.

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 use the Essbase REST API to validate the syntax of your calc script content before you create the calc 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

The following REST call checks if the calc script syntax SET UPDATECALC; CALC ALL; is valid for the Sample Basic cube.

call properties.bat
curl -X POST https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/scripts/scriptops/validate -H "accept: application/json" -H "Content-Type:application/json" -d '{"content": "SET UPDATECALC; CALC ALL;"}' -u %User%:%Password%

Example of Response Body

A response is only returned if there are syntax errors in the calc script content.

{
  "errorMessage" : "Invalid Calc Script syntax [SET UPDATECALC;]",
  "errorCode" : 1012001
}

The SET UPDATECALC command requires an ON or OFF parameter, so the validation returned an error (did not pass).