Get Scenario Detail
Returns metadata for one scenario.
When fields is omitted, all supported scenario properties are returned. When fields is supplied but blank or contains only commas/whitespace, no scenario properties are returned. Nonblank field tokens are trimmed, case-insensitive, and de-duplicated; only supported requested properties are returned. Links are included in the same response body, independently of field selection.
Required Roles
Service Administrator
REST Resource
GET
/HyperionPlanning/rest/sm/v1/applications/{application}/models/{model}/scenarios/{scenario}
Request
Parameters:
Table 3-726 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 |
fields |
Comma-separated list of scenario field names to include in the response. Supported values: name, description, inheritanceMethod, useActuals, parentScenario, accounts, inheritedScenarios, inheritanceSequence, isBase, and isActual. For the scenario collection, omitting fields or supplying an empty or comma/whitespace-only value returns name and description; supported requested properties are added to those fields. Null descriptions are omitted. For an individual scenario, omitting fields returns all supported properties; supplying an empty or comma/whitespace-only value returns no scenario properties. Tokens are trimmed, lowercased, and de-duplicated. Links are returned independently of field selection, and null properties are omitted. | Path | No | None |
Example URL:
https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios/Base
Response
Supported Media Types: application/json
Table 3-727 Parameters
| Name | Description |
|---|---|
name |
Name of the returned resource. |
description |
Description of the returned resource. |
inheritanceMethod |
Method the scenario uses to inherit values from its parent. |
useActuals |
Setting that controls whether the scenario uses actual data. |
parentScenario |
Name of the scenario from which this scenario inherits. |
isBase |
Indicates whether this is the base scenario. |
isActual |
Indicates whether this is an actuals scenario. |
accounts |
Account results included in this response. |
links |
Links related to the resource or result. |
links[].href |
Link to the API call. |
links[].action |
HTTP call type. |
links[].rel |
Relationship type for the link. |
links[].data |
Additional link data, if supplied. |
Sample Response
{
"name": "Upside Case",
"description": "Combination of fewer expenses and increased sales volume.",
"inheritanceMethod": "INHERITS",
"useActuals": "NEVER",
"parentScenario": "Base",
"isBase": false,
"isActual": false,
"accounts": [
"v0300",
"v1040",
"v1080:020",
"v1080:030"
],
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios/Upside%20Case",
"action": "GET",
"rel": "canonical",
"data": null
}
]
}
Table 3-728 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. |
500 |
Unexpected server error. |
Sample cURL Command
curl -X GET -u '<USERNAME>:<PASSWORD>' 'https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios/Base'