Get Rollup Status
Returns status for a model and, optionally, a business case.
When model is omitted, the rollup root model is used. When businessCase is omitted, status is returned for the model's active business case. When businessCase is supplied, name matching is case-insensitive.
Required Roles
Service Administrator
REST Resource
GET
/HyperionPlanning/rest/sm/v1/applications/{application}/rollups/{rollup}/status
Request
Parameters:
Table 3-752 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 |
model |
Strategic Modeling model name. | Path | Yes | None |
businesscase |
Business-case name. URL-encode spaces and reserved characters. | Path | Yes | None |
Example URL:
https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup/status
Response
Supported Media Types: application/json
Table 3-753 Parameters
| Name | Description |
|---|---|
modelName |
Name of the model whose rollup status is returned. |
businessCase |
Name of the business case whose rollup status is returned. |
status |
Status reported by the operation. |
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
{
"modelName": "Corporate Plan",
"businessCase": "Expansion Case",
"status": "Ready",
"links": [
{
"href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup/status?model=Corporate%20Plan&businessCase=Expansion%20Case",
"action": "GET",
"rel": "self"
}
]
}
Table 3-754 Status Codes
| Code | Description |
|---|---|
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/status'