Jump to

• Request
• Response

List Essbase Scripts

get

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

Returns all the scripts from the specified application and database.

Request

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

Query Parameters

• file(optional): string

  Type of script file.

  Default Value: calc

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

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

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ScriptList

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ScriptList"
    }
}

Nested Schema : ScriptList

Type: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Script"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Script

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Script"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested 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 get the scripts. The application or database name may be incorrect.

500 Response

Internal Server Error.

Back to Top