Jump to

• Request
• Response

Get Essbase Script RTSVs

get

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

Returns the runtime substitution variables used in the specified script name.

Request

Path Parameters

• applicationName: string

  Application name.

• databaseName: string

  Database name.

• scriptName: string

  Script name.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

List of runtime substitution variables returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object result

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

Nested Schema : result

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":{
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RTSV"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    },
    "xml":{
        "name":"result"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object RTSV

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

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : RTSV

Type: object

Show Source

• allowMissing(optional): boolean
• description(optional): string
• dimension(optional): string
• limit(optional): string
• name(optional): string
• singleChoice(optional): boolean
• type(optional): string
  Allowed Values: [ "STRING", "NUMBER", "DATE", "MEMBER" ]
• value(optional): object value

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "allowMissing":{
            "type":"boolean"
        },
        "dimension":{
            "type":"string"
        },
        "singleChoice":{
            "type":"boolean"
        },
        "type":{
            "type":"string",
            "enum":[
                "STRING",
                "NUMBER",
                "DATE",
                "MEMBER"
            ]
        },
        "value":{
            "type":"object"
        },
        "limit":{
            "type":"string"
        }
    }
}

Nested Schema : value

Type: object

400 Response

Bad Request

Failed to get variables. The application, database, or script name may be incorrect.

500 Response

Internal Server Error.

Back to Top