General Information on Web Interfaces

• In order to be able to use the interface, the PLANTA link web services must be activated and configured in the web.conf:
  • generic_service = true
  • generic_service_interface and generic_service_port contain reasonable data.
• If the web services are not activated, the buttons for the execution of different actions for which the web services are required, are not displayed at some positions.
• NEW Web interfaces use the Fully Qualified Domain Name (FQDN) as an address by default. If it is not available, the host name of the machine is used. If it is not available, the IP of the machine is used. You can define an explicit host name with the planta_link_hostname global setting.

Please pay attention to upper and lower case spelling in all fields in the web interface modules!

• In order to be able to use the interface, the PLANTA link web services must be activated and configured in the web.conf:
  • generic_service = true
  • generic_service_interface and generic_service_port contain reasonable data.
  • Macro 009CW6 has been run once and the service has been restarted.
• If the web services are not activated, the buttons for the execution of different actions for which the web services are required, are not displayed at some positions.

Please pay attention to upper and lower case spelling in all fields in the web interface modules!

• In order to be able to use the interface, the PLANTA link web services must be activated and configured:
  • generic_service = true
  • The generic_service_interface and generic_service_port parameters contain reasonable data.
  • Macro 009CW6 was run once and the service has been restarted.
• If the web services are not activated, the buttons for the execution of different actions for which the web services are required, are not displayed at some positions.

Please pay attention to upper and lower case spelling in all fields in the web interface modules!

Behavior of the DefaultServiceImplementation class:

• GET
  • Data is retrieved from the database based on the configured web entity.
  • You can restrict the selection by using a URL filter.
  • If data is found, the request is answered with status code 200 (Response). This answer contains a json formatted list of return values in its body.
  • If no data is found, the request is answered with status code 404.
• PUT
  • Expects a json encoded dictionary in the body of the HTTP request the key of which matches the assigned web entity.
    • If an attribute is declared as a NEW Mandatory field PUT and is missing in the request, the request fails with status code 400.
    • If there is an additional attribute in the request which does not exist in the web entity as an attribute, the request fails with status code 400.
  • If the correct attributes are specified, the interface loads all lines from the data table of the web entity, restricted by the optional URL filter.
  • The respective data is updated with the transferred attributes.
  • If everything has worked out, the response is returned with status code 200.
• POST
  • Expects a json encoded dictionary in the body of the HTTP request the key of which matches the assigned web entity.
    • If an attribute is declared as a NEW Mandatory field POST and is missing in the request, the request fails with status code 400.
    • If there is an additional attribute in the request which does not exist in the web entity as an attribute, the request fails with status code 400.
  • If you have specified the correct attributes, the interface creates a new record in the data table of the web entity.
  • The auto number DIs are filled automatically, regardless of whether they are specified as attributes in the web entity.
  • The transferred values are written in the respective columns.
  • If everything has worked out, the response is returned with status code 200.
  • In the body of the response, there is a json encoded dictionary which contains the Python IDs of the auto numbers as a key and their generated value as a value.
• DELETE
  • Deletes all data from the table of the web entity, restricted by the optional URL filter.
  • If at least one line has been deleted, the response has status code 200.
  • If no data has been deleted, the response has status code 404.

Behavior of the DefaultServiceImplementation class:

• GET
  • Data is retrieved from the database based on the configured web entity.
  • You can restrict the selection by using a URL filter.
  • If data is found, the request is answered with status code 200 (Response). This answer contains a json formatted list of return values in its body.
  • If no data is found, the request is answered with status code 404.
• PUT
  • Expects a json encoded dictionary in the body of the HTTP request the key of which matches the assigned web entity.
    • If an attribute is declared as a mandatory field and is missing in the request, the request with status code 500 fails.
    • If there is an additional attribute in the request which does not exist in the web entity as an attribute, the request fails with status code 500.
  • If the correct attributes are specified, the interface loads all lines from the data table of the web entity, restricted by the optional URL filter.
  • The respective data is updated with the transferred attributes.
  • If everything has worked out, the response is returned with status code 200.
• POST
  • Expects a json encoded dictionary in the body of the HTTP request the key of which matches the assigned web entity.
    • If an attribute is declared as a mandatory field and is missing in the request, the request with status code 500 fails.
    • If there is an additional attribute in the request which does not exist in the web entity as an attribute, the request fails with status code 500.
  • If you have specified the correct attributes, the interface creates a new record in the data table of the web entity.
  • The auto number DIs are filled automatically, regardless of whether they are specified as attributes in the web entity.
  • The transferred values are written in the respective columns.
  • If everything has worked out, the response is returned with status code 200.
  • In the body of the response, there is a json encoded dictionary which contains the Python IDs of the auto numbers as a key and their generated value as a value.
• DELETE
  • Deletes all data from the table of the web entity, restricted by the optional URL filter.
  • If at least one line has been deleted, the response has status code 200.
  • If no data has been deleted, the response has status code 404.