Get a Business Case

Returns the current rollup status and active flag for one business case. Business-case name matching is case-insensitive.

Required Roles

Service Administrator

REST Resource

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

Request

Parameters:

Table 3-747 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
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/businesscases/Expansion%20Case

Request body

{
  "name": "Expansion Case",
  "leafNodeScenario": "Base"
}

Response

Supported Media Types: application/json

Table 3-748 Parameters

Name Description
name Name of the returned resource.
status Status reported by the operation.
active Indicates whether the business case is active in the scenario 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.

Example of Response body

{
  "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": "self"
    }
  ]
}

Table 3-749 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/businesscases/Expansion%20Case'