Get Rollup Details

Returns the rollup name, its root model, and the root-model scenarios that can be used as leaf-node scenarios when creating a business case.

Required Roles

Service Administrator

REST Resource

GET /HyperionPlanning/rest/sm/v1/applications/{application}/rollups/{rollup}

Request

Parameters:

Table 3-738 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

Example URL:

https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup

Response

Supported Media Types: application/json

Table 3-739 Parameters

Name Description
name Name of the returned resource.
rootModel Model at the root of the rollup.
rootModelScenarios Scenarios in the root model used by the rollup.
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

{
  "name": "Corporate Rollup",
  "rootModel": "Corporate Plan",
  "rootModelScenarios": [
    "Base",
    "Upside",
    "Downside"
  ],
  "links": [
    {
      "href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup",
      "action": "GET",
      "rel": "canonical"
    },
    {
      "href": "https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup/businesscases",
      "action": "GET",
      "rel": "child"
    }
  ]


Table 3-740 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'