Create or Update All Substitution Variables Defined for the Application
Can be used to create or update substitution variables for the application.
Variables in the payload that exit in the application at the defined scope will be updated; new variables will be created at the defined scope.
Required Roles
Service Administrator
REST Resource
POST /HyperionPlanning/rest/{api_version}/applications/{application}/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 |
Example URL
https://<BASE-URL>/HyperionPlanning/rest/v3/applications/Vision/substitutionvariables
Example Payload
With the following payload, CurrYear
at the application level will be updated, and CurrPeriod
will be created at the Plan3
level.
{
"items": [{
"name": "CurrYear",
"value": "FY18",
"planType": "ALL"
}, {
"name": "CurrPeriod",
"value": "Dec",
"planType": "Plan3"
}]
}
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.