Getting and Setting Substitution Variables

You can use REST APIs to get and set substitution variables at the plan level and application level, as summarized here.

You can also use REST APIs to delete substitution variables. See Deleting Substitution Variables.

Required Roles

Service Administrator, Power User (with Rule Launch access)

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

Table 8-75 Getting and Setting Substitution Variables

Task	Request	REST Resource
Get All Substitution Variables Defined for the Application	GET	/HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables
Get a Substitution Variable Defined for the Application	GET	/HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables/MyPeriod
Create or Update All Substitution Variables Defined for the Application	POST	/HyperionPlanning/rest/{api_version}/applications/{application}/substitutionvariables
Get Substitution Variables Defined at the Plan Type Level	GET	/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables
Get Derived Substitution Variables at the Plan Type Level	GET	/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables?q={"derivedValues":true}
Get a Substitution Variable Defined at the Plan Type Level	GET	/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables/CurrYear
Get a Derived Substitution Variable Defined at the Plan Type Level	GET	HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables/MyPeriod?q={"derivedValues":true}
Create and Update Substitution Variables at the Plan Type Level	POST	/HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables