Create a Business Case
Creates a root business case based on an existing root-model scenario. The response represents the newly created resource and its Location header identifies that resource.
Required Roles
Service Administrator
REST Resource
POST
/HyperionPlanning/rest/sm/v1/applications/{application}/rollups/{rollup}/businesscases
Request
Parameters:
Table 3-744 Parameters
| Name | Description | Type | Required | Default |
|---|---|---|---|---|
name |
Name of the new business case. The name must be valid and unique within the rollup. Minimum length: 1 | Path | Yes | None |
leafNodeScenario |
Name of an existing root-model scenario to assign to the rollup leaf nodes. Minimum length: 1 | Path | Yes | None |
Example URL:
https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup/businesscases
Request body
{
"name": "Expansion Case",
"leafNodeScenario": "Base"
}
Response
Supported Media Types: application/json
Table 3-745 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[].rel |
Relationship type for the link. |
links[].action |
HTTP call type. |
links[].href |
Link to the API call. |
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": "canonical"
}
]
}
Table 3-746 Status Codes
| Code | Description |
|---|---|
400 |
Invalid request, malformed query JSON, invalid parameter, or service validation failure. |
401 |
Authentication is required. |
404 |
Application or requested sub-resource was not found. |
409 |
The requested mutation conflicts with current model state. |
500 |
Unexpected server error. |
Sample cURL Command
curl -X POST -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/json' --data '{"name":"Expansion Case","leafNodeScenario":"Base"}' 'https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup/businesscases'