Getting and Setting Substitution Variables for Planning

You can get and set substitution variables at the plan level and application level using a set of REST resources, as summarized here.

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See About the REST APIs. Using these REST APIs requires prerequisites. See Prerequisites.

Table 5-67 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}/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