Plan Administration API
Manage collaboration projects in your plans.
Access requirements
To use the APIs, you must have a Visier account. 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.
You must be the plan owner or have co-owner access to the plan. For more information, see How to Share Your Plan.
Reach out to your administrator for access.
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.