Change Planning Unit Status

You can use REST APIs to change the status of the planning units consisting of the specified scenario, version, and PM Members (Entity: Secondary member) that are owned by the requesting user.

An error will display if the planning units belong to same hierarchy but different levels, or if the statuses for the planning units are not the same.

Supported actions for limited approvals functionality are: "PROMOTE" (6), "SIGN_OFF" (3), "APPROVE" (2), "DELEGATE" (7), "TAKE_OWNERSHIP" (8), "ORIGINATE" (9), "FREEZE" (10)

Required Roles

Service Administrator

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application}/planningunits/{puhIdentifier}/actions

Request

Supported Media Types: application/x-www-form-urlencoded

Parameters:

The following table summarizes the client request.

Table 8-65 Parameters

Name	Description	Type	Required	Default
api_version	Version of the API you are developing with	Path	Yes	None
application	The name of the application	Path	Yes	None

Example URL and Payload

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/planningunits/Forecast::"BU Version_1"/actions

Payload

actionId=actionId&pmMembers=pmMemberNames&comments=comments

Response

Supported Media Types: application/json

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "links": [{
        "rel": "self",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4app1/planningunits/Forecast::%22BU%20Version_1%22/actions",
        "action": "POST",
        "data": {
            "pmMembers": "\"Dev\"",
            "action": "PROMOTE",
            "comments": "\"Promoting the PU\""
        }
    }]
}