Get All Substitution Variables Defined for the Application
You can use REST APIs to retrieve all substitution variables defined for the application (all plan types).
Required Roles
Service Administrator, Power User (with Rule Launch access)
REST Resource
GET /HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables
Request
Supported Media Types: application/json
Parameters
The following table summarizes the client request.
Table 8-77 Parameters
Name | Description | Type | Required | Default |
---|---|---|---|---|
api_version |
Version of the API you are developing with | Path | Yes | None |
application |
The name of the application | Path | Yes | None |
Example URL
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/substitutionvariables
Response
Supported Media Types: application/json
Parameters
The following table summarizes the parameters.
Table 8-78 Parameters
Name | Description |
---|---|
items |
Collection of information about the resource |
name |
Name of the substitution variable, such as CurrYear |
value |
Value of the substitution variable, such as FY16 |
planType |
Plan type, such as Plan1, or ALL for all plan types |
Example of Response Body
The following shows an example of the response body.
{
"items": [{
"name": "CurrYear",
"value": "FY16",
"planType": "ALL"
}, {
"name": "CurrYear",
"value": "FY17",
"planType": "Plan2"
},{
"name": "CurrPeriod",
"value": "Jan",
"planType": "Plan1"
}, {
"name": "CurrPeriod",
"value": "Feb",
"planType": "ALL"
}]
}