Submit a Rollup Execution

Submits an asynchronous rollup execution for one model and one or more business cases. A successful submission does not mean execution has completed. Follow the Location header to retrieve Planning job status.

Required Roles

Service Administrator

REST Resource

POST /HyperionPlanning/rest/sm/v1/applications/{application}/rollups/{rollup}/action/run

Request

Parameters:

Table 3-755 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
modelName Name of the model in the rollup to run. Minimum length: 1 Path Yes None
businessCases Business cases to include in the rollup execution. Minimum items: 1 Path Yes None
businessCases[].name Name of an existing business case in the specified model. Minimum length: 1 Path Yes None
businessCases[].refresh Whether to refresh the business case during the rollup execution. Default: false Path No None
businessCases[].publish Whether to publish the business case during the rollup execution. Default: false Path No None
forceRollup Whether to run the rollup even when the selected business case does not otherwise require a rollup, refresh, or publish operation. Path No False

Example URL:

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

Request body

{
  "modelName": "Corporate Plan",
  "businessCases": [
    {
      "name": "Expansion Case",
      "refresh": false,
      "publish": false
    }
  ]
}

Response

Supported Media Types: application/json

Table 3-756 Parameters

Name Description
jobId Identifier of the submitted job.
status Status reported by the operation.

Sample Response

{
  "jobId": 12345,
  "status": "Rollup job submitted"
}

Table 3-757 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 POST -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/json' --data '{"modelName":"Corporate Plan","businessCases":[{"name":"Expansion Case","refresh":false,"publish":false}]}' 'https://<BASE-URL>/HyperionPlanning/rest/sm/v1/applications/Sample/rollups/Corporate%20Rollup/action/run'