List Scenario Rollups
Returns a paged collection of scenario-rollup summaries.
A rollup from this collection can be addressed at
/applications/{application}/rollups/{rollup}; the sub-resource
locator verifies the rollup exists and returns 404 when it does not
Required Roles
Service Administrator
REST Resource
GET
/HyperionPlanning/rest/sm/v1/applications/{application}/rollups
Request
Table 3-735 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
The name of the application | Path | Yes | None |
offset |
The index from which the records are returned. It is a 0 based non-negative integer. | 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/rollups
Response
Supported Media Types: application/json
Table 3-736 Parameters
| Name | Description |
|---|---|
count |
Count reported for the returned collection. |
links |
The links related to the resource or result. |
offset |
The zero-based index from which the records are returned. |
limit |
The page size for the returned records. |
hasMore |
True or False, if there are more pages of records |
Sample Response
{
"items": [
{
"name": "r4",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/r4",
"action": "GET",
"rel": "canonical",
"data": null
}
]
}
],
"count": 1,
"offset": 1,
"limit": 1,
"hasMore": true,
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/",
"action": "GET",
"rel": "canonical",
"data": null
},
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/?offset=1&limit=1",
"action": "GET",
"rel": "self",
"data": null
},
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/?offset=0&limit=1",
"action": "GET",
"rel": "prev",
"data": null
},
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/?offset=2&limit=1",
"action": "GET",
"rel": "next",
"data": null
}
]
}
Table 3-737 Status Codes
| Code | Description |
|---|---|
| 400 | Invalid paging parameter or request. |
| 401 | Authentication is required. |
| 403 | The authenticated caller is not authorized. |
| 404 | Application or requested sub-resource was not found. |
Sample cURL Command
curl -X GET -u '<USERNAME>:<PASSWORD>' 'https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups'