Get a Substitution Variable Defined at the Plan Type Level

Can be used to retrieve a substitution variable defined at the plan type level.

REST Resource

GET       /HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables/CurrYear

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 5-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://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/vision/plantypes/plan1/substitutionvariables/CurrYear

Response

Supported Media Types: application/json

Parameters

The following table summarizes the parameters.

Table 5-78 Parameters

Name Description
name Name of the substitution variable, such as CurrYear
value Value of the substitution variable, such as FY16
planType Name of the plan type, such as Plan1

Example of Response Body

The following shows an example of the response body.

{
    "name": "CurrYear",
    "value": "FY17",
    "planType": "Plan1",
    "links": [{
        "rel": "self",
        "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/vision/plantypes/plan1/substitutionvariables/CurrYear",
        "action": "GET"
    }]
}