DT590 Web interface

DI064130 UUID

Universally Unique Identifier of the selected web interface (primary key)

DI064144 Name

Name of a web interface. The name is arbitrary.

DI064145 Active

Specifies whether a web interface is active. Before a web interface is used, this parameter must be set in the Web Interfaces module.

DI064156 Url

URL is the configurable part of a URL under which a web interface can be reached. The URL of a web interface always has an /api/ prefix.

DI064231 Complete URL

A virtual data item which shows the complete URL under which the web interface can be reached. The URL of a Web interface can be queried via interface.get_web_interface_url_by_python_id(python_id).

DI064253 API key

API key serves to authenticate the request. If a request is executed on the URL of a web interface, the API key must be included in the HTTP headers with the key “apikey”, otherwise the server will return HTTP 403 (Unauthorized).

DI066407 Python ID

Python ID of the web interface. The Python IDs of the PLANTA standard interface cannot be changed by the customer. Customer-individual Python IDs must always start with L<license_number>.

DI064267 GET implementation

Specifies the web service implementation for a GET request.

DI064268 POST implementation

Specifies the web service implementation for a POST request.

DI064269 PUT implementation

Specifies the web service implementation for a PUT request.

DI064270 DELETE implementation

Specifies the web service implementation for a DELETE request.

DI064281 Owner license

DI064287 Listbox: Grouping name

DI064300 GET entity (incarnation)

Specifies the entity to be used for a GET request.

DI064302 POST entity (incarnation)

Specifies the entity to be used for a POST request.

DI064306 PUT entity (incarnation)

Specifies the entity to be used for a PUT request.

DI064309 DELETE entity (incarnation)

Specifies the entity to be used for a DELETE request.

DI064682 Log level name (incarnation)

Depending on your selection, it specifies what is to be logged when using web interfaces:

• Debugging info:
  • This value is only visible to customizers (users with Customizer rights = ).
  • All log messages are written in the log file.
• Information:
  • Contains useful information that may help you to comprehend the interface.
• Warning:
  • Only writes warnings and errors in the log.
• Deactivated:
  • No log is written for this value.

DI066100 Requests

Specifies the number of requests of the corresponding web interface.

DI0066495 Authentication

Parameter for defining an authentication method for a web interface. The corresponding listbox offers the following values:

• None
  • No check is performed, the interface accepts any request. Corresponds to the behavior with apikey_auth_filter_generic = false but can be configured per interface.
• API key
  • An HTTP header with “Apikey” key and the valid API key must be included so that the web interface processes the request. Corresponds to the behavior with apikey_auth_filter_generic = true but can be configured per interface.
• Token
  • A valid token must be transferred in the URL of the web interface. The token is expected at the beginning of the URL after /url/. The “Complete URL ” value range indicates this by showing a /{apitoken}/ in the URL.