Delete a Scenario
Deletes a scenario.
Required Roles
Service Administrator
REST Resource
DELETE
/HyperionPlanning/rest/sm/v1/applications/{application}/models/{model}/scenarios/{scenario}
Request
Parameters:
Table 3-732 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
Strategic Modeling application name. | Path | Yes | None |
model |
Strategic Modeling model name. | Path | Yes | None |
scenario |
Scenario name. | Path | Yes | None |
Example URL:
https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios/Base
Response
Supported Media Types: application/json
Table 3-733 Parameters
| Name | Description |
|---|---|
name |
Name of the scenario. |
description |
Description of the scenario. |
inheritanceMethod |
Method the scenario uses to inherit values. |
useActuals |
Setting that controls whether the scenario uses actual data. |
|
Name of the scenario’s parent scenario. |
|
Account IDs associated with the scenario. |
inheritedScenarios |
Additional scenarios from which this scenario inherits, in order; empty here. |
inheritanceSequence |
Sequence of scenario inheritance, shown from this scenario to its parent. |
isBase |
Indicates whether this is the base scenario. |
isActual |
Indicates whether this is an actuals scenario. |
links |
Links related to the scenario. |
links[].href |
URL of the linked resource. |
links[].action |
HTTP method for the link. |
links[].rel |
Relationship of the link to the scenario, such as
canonical.
|
links[].data |
Additional link data, if provided; null in this
example.
|
Table 3-734 Status Codes
| Code | Description |
|---|---|
400 |
Invalid request, malformed query JSON, invalid parameter, or service validation failure. |
401 |
Authentication is required. |
403 |
The authenticated caller is not authorized. |
404 |
Application or requested sub-resource was not found. |
422 |
The required scenario or period query parameter is missing or empty. |
500 |
Unexpected server error. |
Sample cURL Command
curl -X DELETE -u '<USERNAME>:<PASSWORD>' 'https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios/Base'