Get Substitution Variables Defined at the Plan Type Level

You can use REST APIs to retrieve a list of retrieve a list of substitution variables defined at the plan type level.

Required Roles

Service Administrator, Power User (with Rule Launch access)

Rest Resource

GET       /HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 8-81 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
`plantype`	The plan type for which to get substitution variables	Path	Yes	None

Example URL

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/substitutionvariables

Response

Supported Media Types: application/json

Parameters

The following table summarizes the parameters.

Table 8-82 Parameters

Name	Description
`items`	Collection of information for the resource
`name`	Name of the substitution variable, such as CurrPeriod
`value`	Value of the substitution variable, such as Jan
`planType`	Name of the plan type, such as Plan1

Example of Response Body

The following shows an example of the response body.

{
    "items": [{
        "name": "CurrPeriod",
        "value": "Jan",
        "planType": "Plan1"
    }]
}