Web Interface Workflow: DELETE New from DB 39.5.10

Information

• The following workflow provides basic knowledge required to create an interface in PLANTA project using the functions delivered.
• The objective of this workflow is a web interface which deletes the logging records of the PLANTA link interfaces.

Requirements

• Basic customizing knowledge
• Basic knowledge of REST

Notes

Create Web Entity

Objective

• To create a web entity which describes our data

Procedure

• Open the Configuration
• Insert a new entity in the Web Entities submodule
  • via the Insert Web Entity context menu entry
  • or by clicking on the Insert button
• Specify a name and select table 463 in the Data table field.
• Save.

Create Web Interface

Objective

• To create a web interface which processes incoming requests and creates our tasks

Procedure

• Open the Configuration panel
• Create a new web interface
  • via the Insert Web Interface context menu entry
  • or by clicking on the Insert button
• Fill the fields as follows:
  • The Name is arbitrary
  • The Active field must be activated before the interface is used.
  • Create a placeholder in the Url field, for example: /interface/log/
  • Allocate an API key
  • Select the DefaultServiceImplementation DELETE implementation
  • The entity created in the previous step is selected in the Web entity field
• Save.

Test Web Interface

Objective

• To test the newly created web interface

Procedure

• Click on the earth button to open the Test Web Interface module
• Select DELETE as HTTP-method
• Click on the Run button
  • The placeholder in the URL is automatically replaced by the transferred value and the API key is handed on in the HTTP header.
• As a response to a successful query, the server responds with the number of deleted records.
  • Example: {"result": "Deleted 29 objects"}

Tip

• With a URL filter, the amount of records to be deleted can be restricted.