Plan Administration API
Manage collaboration projects in your plans.
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 Customer/Partner Success Manager.
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 be the plan owner or have co-owner access to the plan. For more information, see How to Share Your Plan.
Not sure if you have this feature or capability? Reach out to your administrator.
Overview
You can use the Plan Administration API to manage collaboration projects in 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 collaboration projects in plans using Visier APIs is:
- Retrieve plan ID and scenario ID: Retrieve a list of all accessible plans, and identify the desired plan's ID and scenario ID. For each plan, the API response returns its ID, display name, planning model, scenarios, collaborations, and currency code. For more information, see "Retrieve a list of plans" in API Reference.
- Partially update a subplan: With the plan ID and scenario ID, update a subplan with the desired action such as consolidating, reopening, submitting, starting collaboration, or ending collaboration.