About the Planon REST API
The Planon application supports REST API, but what does that mean? It allows you to create an interface that is best suited for machine-to-machine communication. The difference between these protocols is that REST API is much more efficient and requires fewer calls to the application.
The Planon REST API only makes use of the POST method. In addition, it uses parameters for the four CRUD operations: Create, Retrieve, Update, and Delete.
The Planon REST API is designed with system-to-system communication in mind.
With the Planon REST API, a user can define the response for an API request based on a Planon business object (BO).
All operations on BOs are triggered by so-called Business Object Methods (BOMs). These BOMs are there to manipulate the BO they belong to. The Planon REST API supports this.
The Planon REST API has three generic endpoints:
• /execute - used for executing BOMs
• /lookup - the standard Planon Lookup functionality
• /changeState - for doing state changes on a BO
To keep more in line with a standard REST API we also created three endpoints for Read, Update and Delete, which are in fact redirects to the /execute endpoint.
• /read
• /update
• /delete
• /upload
• /download
Because there are various Add BOMs in all Planon BOs, it was decided not to create a /create endpoint to avoid confusion. If creates are allowed for a BOM, these can be found in the list of methods to execute.
 | More about endpoints and examples can be found under: Endpoints. |