Jump to

• Request
• Response

Validate Essbase 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: string

  Application name.

• databaseName: string

  Database name.

Query Parameters

• file(optional): string

  File.

  Default Value: calc

Body ()

Script details.

Root Schema : Script

Type: object

Show Source

• content(optional): string
• links(optional): array links
• locked(optional): boolean
• lockedBy(optional): string
• lockedTime(optional): integer(int64)
• modifiedTime(optional): integer(int64)
• name(optional): string
• sizeInBytes(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "content":{
            "type":"string"
        },
        "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"
        }
    }
}

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(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

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

Back to Top

Response

200 Response

OK

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.

Back to Top