Important
This module is only available in the Enterprise Edition.
This module implements a multi-threaded REST webservice server. Using the web service frePPLe can make the plan information on-line accessible to other systems and users, and also receive updated input data. FrePPLe can thus integrate flexibly in a Service Oriented Architecture (SOA), sharing information with other applications.
An overall overview is provided in the index page at the root level http://<address>:<port>/.
Read data
HTTP GET-requests to the following URLs are used to read information from frePPLe:
Write data
Control actions
HTTP requests to the following URLs are used to control the service:
The web service is started by calling the Python function freppledb.quoting.Server(database=’default’) in a commands.py file. The address and port are configured with the parameter quoting.service_url and default to localhost:8001.
Note that the module works with the frePPLe objects loaded in memory. Unless configured accordingly, it does not persist any data in the database (with the exception or order quotes). This is different from the screens in the frePPLe user interface, which all display planning data stored in the database.
Access to the service is open and unauthenticated by default, and hence only suitable for local connections or on a secure internal network. Plugins can be developed to implement authentication and access restrictions, using the CherryPy HTTP framework. Contact us for info or assistance.