Get started¶
The Plotwise API is an API that allows you to prepare a plan, introduce the required data, interact with an up-to-date real-time plan and request for an optimized and finalized plan.
The Plotwise API is stateless, however, the objects and entities in it are not. So a plan in Plotwise Continuous Planning Flow has its own states and is divided into the following phases: Initialization, Open planning, Finalization and Execution.
During these phases, multiple planning actions can be performed as highlighted in the graph and explained in more detail per phase.
Initialization¶
This is the phase where we expect the plan to be set up. You must prepare the system for a new plan.
In this phase you will:
- Create a bucket with a profile and all the plan configuration
- Add the available resources
- Introduce all the orders that are already known. Example
- Initialize the bucket. Note This action is the trigger to move to the next phase. Example
Once the bucket is initialized, the planning is considered open and it is possible to interact with it.
Details
You can find all the details of this process in here
Open planning¶
At this point, the plan is open for orders to be added and planned. Plotwise magic is running continuously and is making sure all the new information is introduced and managed in the most efficient way.
In this phase you can:
- Add new orders
- Retrieve a tentative planning
- Interfere with the planning. Example: Fetch suggestions, change addresses, change route and resources, etc.
- Optimize/finalize the plan Note This action is the trigger to move to the next phase.
Details
You can find all the details of this process in here
Finalization¶
This is the phase where you "close" your plan. You will retrieve the finalized and most optimized plan.
Details
You can find all the details of this process in here
Execution¶
Now it is your time to shine, we've provided you of the most optimal plan you could ever have. It is time to hit the road
and Execute the plan.
Once you executed the plan, we are very curious about the realization of it and are happy to continuously improve our planning solution with it.