Jump to

• Request
• Response

Create Essbase Script

post

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

Creates the script in the specified application and database and returns the created script.

Request

Supported Media Types

• application/json

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Query Parameters

• file(optional): string

  Type of script 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 created successfully, including script details and links to get, edit, or delete the script and to get its contents.

Body ()

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

400 Response

Bad Request

Failed to create the script. The application or database name may be incorrect, the JSON for the script 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.

Back to Top