Create and Update Substitution Variables at the Plan Type Level

You can use REST APIs to create and update substitution variables at the plan type level. Variables in the payload that exist at the plan type level are updated. New variables are created at the plan type level.

Required Roles

Any Role

REST Resource

POST       /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-118 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	Name of the plan type for which to get and set substitution variables	Path	Yes	None

Example URL

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/plantypes/Plan1/substitutionvariables

Response

Supported Media Types: application/json

Example of a successful response

Http status code: 204 (No content)

Example of an error response

Http status: 400

To confirm the results, you can go to the application to see the updates.