Delete Substitution Variables at the Plan Type Level

Use this REST API to delete substitution variables at the plan type level. Variables in the payload that exist at the plan type level are deleted.

Before deleting substitution variables, you can use REST APIs to get information on what substitution variables are defined for the application or plan type. See Getting and Setting Substitution Variables.

Required Roles

Service Administrator

REST Resource

POST       /HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/substitutionvariables:delete

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 8-93 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with, v3	Path	Yes	None
plantype	The name of the plan type for which to delete the 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:delete

Example Payload

The following payload will delete CurrYear and CurrPeriod at the Plan1 level.

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

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