Delete Substitution Variables for the Application

Use this REST API to delete substitution variables defined for the application (for all plan types). Variables that exist at the plan type level or application 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}/substitutionvariables:delete

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 8-94 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with, v3	Path	Yes	None

Example URL

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/Vision/substitutionvariables:delete

Example Payload

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

{
    "items": [{
        "name": "CurrPeriod",
        "value": "Jan",
        "planType": "ALL"
    }, {
        "name": "CurrYear",
        "value": "FY23",
        "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

Example of Response Body

The following shows an example of the response body.

{
    "items": [{
        "name": "CurrYear",
        "value": "FY16",
        "planType": "ALL"
    }, {
        "name": "CurrYear",
        "value": "FY17",
        "planType": "Plan2"
    },{
        "name": "CurrPeriod",
        "value": "Jan",
        "planType": "Plan1"
    }, {
        "name": "CurrPeriod",
        "value": "Feb",
        "planType": "ALL"
    }]
}