List Business Cases
Returns the business cases defined at the rollup root. Results are paged. Omitted paging parameters use the service defaults.
Required Roles
Service Administrator
REST Resource
GET
/HyperionPlanning/rest/sm/v1/applications/{application}/rollups/{rollup}/businesscases
Request
Parameters:
Table 3-741 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
application |
Strategic Modeling application name. | Path | Yes | None |
rollup |
Existing scenario rollup name. URL-encode spaces and reserved characters. | Path | Yes | None |
offset |
The zero-based index from which records are returned. 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/rollups/Corporate%20Rollup/businesscases
Response
Supported Media Types: application/json
Table 3-742 Parameters
| Name | Description |
|---|---|
items |
Collection of information about the returned resources. |
items[].name |
Name of the returned resource. |
items[].status |
Status reported by the operation. |
items[].active |
Indicates whether the business case is active in the scenario rollup. |
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. |
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. |
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. |
Sample Response
{
"items": [
{
"name": "Expansion Case",
"status": "Ready",
"active": true,
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup/businesscases/Expansion%20Case",
"action": "GET",
"rel": "canonical"
}
]
}
],
"count": 1,
"offset": 0,
"limit": 100,
"hasMore": false,
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup/businesscases",
"action": "GET",
"rel": "canonical"
}
]
}
Table 3-743 Status Codes
| Code | Description |
|---|---|
400 |
The request is malformed, fails validation, or contains an invalid rollup input. |
401 |
Authentication is required. |
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/rollups/Corporate%20Rollup/businesscases'