Get Available Planning Unit Actions

You can use REST APIs to return a list of the next set of applicable actions available for the planning units, consisting of the specified scenario, version, and PM Members (Entity: Secondary member) that are owned by the requesting user.

Required Roles

Service Administrator

REST Resource

POST

/HyperionPlanning/rest/{api_version}/applications/{application}/planningunits{puhIdentifier}/availableactions

Request

Parameters:

The following table summarizes the client request.

Table 8-61 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
puIdentifier	The name of the planning unit, such as Sales	Path	Yes	None
q	Optionally, return limited or full approvals functionality. Options are listed here.	Query	No	None
0	Returns limited approvals functionality - useful for mobile clients	Query	No	None
1	Returns full approvals functionality; default is 1.	Query	No	None

URL and Payload Examples

https://<BASE-URL>/rest/v3/applications/PS4app1/planningunits/Forecast::"BU Version_1"/availableactions?q={"options":1}

Payload examples:

pmMembers=pmMemberNames

pmMembers=Dev,Marketing

Response

Supported Media Types: application/json

Parameters:

Table 8-62 Parameters

Name	Description
Items	Planning unit available actions
actionId	ID of the action
Name	Name of the action

Example of Response Body

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

{
    "items": [{
        "actionId": 6,
        "name": "Promote"
    }, {
        "actionId": 3,
        "name": "Sign Off"
    }, {
        "actionId": 1,
        "name": "Reject"
    }, {
        "actionId": 7,
        "name": "Delegate"
    }, {
        "actionId": 8,
        "name": "Take Ownership"
    }, {
        "actionId": 9,
        "name": "Originate"
    }, {
        "actionId": 10,
        "name": "Freeze"
    }],
    "links": [{
        "rel": "self",
        "href": "https://<BASE-URL>/HyperionPlanning/rest/v3/applications/PS4_HP2/planningunits/Current::%22BU%20Version_1%22/availableactions?q=%7Boptions:1%7D",
        "action": "GET",
        "data": {
            "pmMembers": "ent_111: Regular Coke"
        }
    }],
}