Manage Planning Units
You can manage planning units using a set of REST resources, as summarized here.
Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.
For detailed information on managing planning units, see Managing Approvals.
Note: The manage planning unit resources use the parameters puIdentifier and puhIdentifier:
-
puIdentifier: Planning unit identifier -
puhIdentifier: Planning unit hierarchy identifier
Use the following format for these parameters:
-
puIdentifier:"scenarioName"::"versionName"::"pmMember" -
pmMember:"Entity: SecondaryMember" -
puhIdentifier"scenarioName"::"versionName"
Table 8-50 Managing Planning Units
| Task | Request | REST Resource |
|---|---|---|
| List All Planning Units | POST | /HyperionPlanning/rest/{version}/applications/{application}/planningunits?q={"scenario":"scenarioName","version":"versionName"}&offset=10&limit=10 |
| Get Planning Unit History and Annotations | GET | /HyperionPlanning/rest/{api_version}/applications/{application}/planningunits?q={"scenario":{"scenario"},"version":{"version"}}&offset={offset}&limit={limit} |
| Get a Planning Unit Owner Photo | GET | /HyperionPlanning/rest/{api_version}/applications/{application}/users/{userId}/photo |
| Get Planning Unit Promotional Path | GET | /HyperionPlanning/rest/{api_version}/applications/{application}/planningunits/{puIdentifier}/promotionpath |
| Get Available Planning Unit Actions | GET | /HyperionPlanning/rest/{api_version}/applications/{applicationName}/planningunits{puhIdentifier}/availableactions |
| Get Filters with All Possible Values | GET | /HyperionPlanning/rest/{api_version}/applications/{application}/pufilters |
| Change Planning Unit Status | POST | /HyperionPlanning/rest/{api_version}/applications/{application}/planningunits/{puhIdentifier}/actions |