Endpoint patterns
The REST API must support all CRUD-operations as well as Execute, Lookup- and Statechange-operations on a selected business object.
• The REST API supports an Execute-operation for executing different actions (BOMs) on a business object.
• The Lookup-operation can be used to retrieve business objects based on a lookup-value.
• It is important to have the Statechange-operation, because changing a business object's status may trigger some business logic.
• There are two endpoints for file handling, one for Uploading and for one for Downloading.
• There is a special endpoint that can retrieve an OpenAPI-document which describes the actual endpoint and can be used in tools as Postman or Swagger.
• There is also the possibility to process up to 20 requests in a batch trough the Batch-endpoint.
In addition to these operations, the REST API also needs to support versioning to be able to implement changes without breaking a customer's implementation. This is a mechanism to keep old definitions active when changing something to the REST API -product. This is NOT something that can be used to version the definitions but a way for Planon the be able to update and extend the functionalities of the REST API without breaking a customer's implementations.
 | In order not to expose too much information in the actual REST API, only POST-requests are used. |
The following sections describe the supported endpoints.