Plan Administration API
Manage your plans by consolidating and reopening subplans.
Note:
- Available with a subscription to Planning.
- Alpha This API is in alpha. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your
Who can use this feature?
To use the APIs, you must have a Visier account with a profile that has the API capability. If you don't have an account, contact your administrator. They will create an account for you with permissions that allow you to view data.
In addition to an API profile, your API user must have permission to edit the plan. For more information, see Planning Capabilities.
Not sure if you have this feature or capability? Reach out to your administrator.
Overview
You can use the Plan Administration API to manage your plans, including actions such as consolidating and reopening subplans. Consolidating a subplan combines the submitted subplan values into the main plan, while reopening consolidated subplans allows subplanners to change the values. For more information on subplans and plan collaboration, see Collaboration Projects.
The process to manage your subplans using Visier APIs is:
- Retrieve plan ID: Retrieve a list of all accessible plans, and identify the desired plan's ID. For each plan, the API response returns its ID, display name, planning model, scenarios, and currency code. For more information, see "Retrieve a list of plans" in API Reference.
- Partially update subplans: With the plan ID, update a subplan or subplans in bulk with the desired action such as consolidating or reopening them.