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
Back to Top

Response

Supported Media Types

200 Response

OK

List of runtime substitution variables returned successfully.

Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : result
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : properties
Type: object
Additional Properties Allowed
Show Source
Nested Schema : RTSV
Type: object

Details about the runtime substitution variable.

Show Source
  • Set to true to allow data cells for which no data exists, or false to suppress them.

  • The name of the dimension from which this variable pulls information. Supported only if type = MEMBER.

  • Name of the runtime substitution variable.

  • Set to true if only one contextual member selection may be passed to the runtime substitution variable. If there is a single member on the grid or POV, that member is used. If a dimension is on the POV, the active member is used. If a dimension is on the POV and there are multiple members, an error occurs.

    Set to false if all dimension members on the grid or the POV are included.

  • Allowed Values: [ "STRING", "NUMBER", "DATE", "MEMBER" ]

    Specification of whether the variable is for a member, string, or number.

  • value

    Default value of the runtime substitution variable. RTSV values can be strings, constants, member names, or member combinations.

    If the RTSV is designed for calcs executed in Smart View, its value must be set to the constant POV, to indicate that only the current data slice present in the spreadsheet grid should be calculated.

Nested Schema : value
Type: object

Default value of the runtime substitution variable. RTSV values can be strings, constants, member names, or member combinations.

If the RTSV is designed for calcs executed in Smart View, its value must be set to the constant POV, to indicate that only the current data slice present in the spreadsheet grid should be calculated.

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

Examples

The following example shows how to use the Essbase REST API to get runtime substitution variables (RTSVs) associated with a 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.

Get Calc Script Run-Time Substitution Variables

call properties.bat
curl -X GET https://myserver.example.com:9001/essbase/rest/v1/applications/Sample/databases/Basic/scripts/pov_scenario_period/rtsv -H "accept: application/json" -u %User%:%Password%

Example of Response Body

{
  "items" : [ {
    "name" : "rtsvEntity",
    "description" : "Entities to Copy",
    "allowMissing" : false,
    "dimension" : "Entity",
    "singleChoice" : false,
    "type" : "MEMBER",
    "value" : "POV"
  }, {
    "name" : "rtsvScenario",
    "description" : "Scenarios to Copy",
    "allowMissing" : false,
    "dimension" : "Scenario",
    "singleChoice" : false,
    "type" : "MEMBER",
    "value" : "POV"
  }, {
    "name" : "rtsvPeriod",
    "description" : "Period to Copy",
    "allowMissing" : false,
    "dimension" : "Period",
    "singleChoice" : true,
    "type" : "MEMBER",
    "value" : "POV"
  } ]
}
Back to Top