List Scenarios
Returns a paged scenario collection.
When fields is omitted, empty, or contains only commas/whitespace, each item contains name and description plus links; null descriptions are omitted. Nonblank field tokens are trimmed, case-insensitive, and de-duplicated; name and any non-null description are returned with any supported requested properties. Unlike this collection, the individual-scenario endpoint returns all supported scenario properties when fields is omitted, with null properties omitted.
Required Roles
Service Administrator
REST Resource
GET
/HyperionPlanning/rest/sm/v1/applications/{application}/models/{model}/scenarios
Request
Parameters:
Table 3-720 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
Strategic Modeling application name. | Path | Yes | None |
model |
Strategic Modeling model 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
|
Query | No | None |
offset |
The zero-based index from which records are returned. If the response omits offset, the paging helper uses 0. Default: 0; Minimum: 0 | Query | No | 0 |
limit |
The number of items to return. Must be a positive integer. Values above 200 are accepted; the effective page size is capped at 200. Default: 100; Minimum: 1 | Query | No | 100 |
Example URL:
https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios
Response
Supported Media Types: application/json
Table 3-721 Parameters
| Name | Description |
|---|---|
items |
Collection of information about the returned resources. |
items[].id |
Identifier of the returned resource. |
|
Name of the returned resource. |
items[].links |
Links related to the resource or result. |
items[].links[].href |
Link to the API call. |
items[].links[].action |
HTTP call type. |
items[].links[].rel |
Relationship type for the link. |
items[].links[].data |
Additional link data, if supplied. |
count |
Count reported for the returned collection; confirm whether this is a page count or total count. |
offset |
The zero-based index from which the records are returned. |
limit |
The page size for the returned records. |
hasMore |
True or false, indicating whether more pages of records are available. |
Sample Response
{
"items": [
{
"name": "Base",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios/Base",
"action": "GET",
"rel": "canonical",
"data": null
}
]
},
{
"name": "Actual",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios/Actual",
"action": "GET",
"rel": "canonical",
"data": null
}
]
},
{
"name": "Upside Case",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios/Upside%20Case",
"action": "GET",
"rel": "canonical",
"data": null
}
]
}
],
"count": 12,
"offset": 0,
"limit": 100,
"hasMore": false,
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/models/M1/scenarios",
"action": "GET",
"rel": "canonical",
"data": null
}
]
}
Table 3-722 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'