DT590 Web-Schnittstelle
DI064130 UUID
Universally Unique Identifier der ausgewählten Web-Schnittstelle (der Primärschlüssel)
DI064144 Bezeichnung
Die Bezeichnung einer Web-Schnittstelle. Bezeichnung ist frei wählbar.
DI064145 Aktiv
Gibt an, ob eine Web-Schnittstelle aktiv ist. Bevor eine Web-Schnittstelle verwendet wird, muss dieser Parameter im Modul Web-Schnittstellen gesetzt werden.
DI064156 Url
URL ist der konfigurierbare Teil der URL, unter der eine Web-Schnittstelle erreichbar ist. Die URL einer Web-Schnittstelle hat immer einen /api/ Präfix.
DI064231 Komplette URL
Ein virtuelles Dataitem, welches die komplette URL anzeigt, unter der die Web-Schnittstelle erreichbar ist. Die URL einer Web-Schnittstelle kann über interface.get_web_interface_url_by_python_id(python_id)abgefragt werden.
DI064253 API-Schlüssel
API-Schlüssel dient der Authentifizierung des Requests. Führt man einen Request auf der URL einer Web-Schnittstelle aus, so muss der API-Schlüssel in den HTTP-Headers mit dem Schlüssel "apikey" mitgegeben werden, sonst gibt der Server HTTP 403 (Unauthorized) zurück.
DI066407 Python-ID
Python-ID der Web-Schnittstelle. Die Python-IDs der PLANTA-Standard-Schnittstellen können nicht kundenseitig geändert werden. Kundenindividuelle Python-IDs müssen immer mit L<license_number> anfangen.
DI066840 Hostname
Parameter zum Festlegen eines Hostnamens speziell für eine bestimmte Web-Schnittstelle. Wird er nicht gesetzt, wird der Hostname von der globalen Einstellung Hostname für Webschnittstellen verwendet, wenn diese gesetzt ist.
Über die Umgebungsvariablen kann ein Hostname für verschiedene Gruppen von Web-Schnittstellen konfiguriert werden:
planta__server__hostname__pulse
planta__server__hostname__jira
planta__server__hostname__adaptive_card
planta__server__hostname__odata
DI064267 GET Implementation
Gibt die Web-Service-Implementation für einen GET-Request an.
DI064268 POST Implementation
Gibt die Web-Service-Implementation für einen POST-Request an.
DI064269 PUT Implementation
Gibt die Web-Service-Implementation für einen PUT-Request an.
DI064270 DELETE Implementation
Gibt die Web-Service-Implementation für einen DELETE-Request an.
DI064281 Owner-Lizenz
DI064287 Listbox Gruppierungsbezeichnung
DI064300 GET Entität (Inkarnation)
Gibt die zu verwendende Entität für einen GET-Request an.
DI064302 POST Entität (Inkarnation)
Gibt die zu verwendende Entität für einen POST-Request an.
DI064306 PUT Entität (Inkarnation)
Gibt die zu verwendende Entität für einen PUT-Request an.
DI064309 DELETE Entität (Inkarnation)
Gibt die zu verwendende Entität für einen DELETE-Request an.
DI064682 Log-Level Bezeichnung (Inkarnation)
Gibt je nach Auswahl an, was bei Verwendung der Web-Schnittstellen geloggt werden soll:
Debugging-Info:
Dieser Wert ist nur für Customizer (Benutzer mit Customizerrechte = ) sichtbar.
Es werden sämtliche Log-Nachrichten ins Logfile geschrieben
Information:
Enthält nützliche Informationen, die zum Nachvollziehen der Schnittstelle hilfreich sein können.
Warnung:
Schreibt nur Warnungen und Fehler ins Log.
Deaktiviert:
Bei diesem Wert wird kein Log geschrieben.
DI066100 Requests
Gibt die Anzahl an Requests der zugehörigen Web-Schnittstelle an.
DI0066495 Authentifizierung
Parameter zum Festlegen einer Authentifizierungsmethode für eine Web-Schnittstelle. Die entsprechende Listbox bietet folgende Werte:
Keine
Es wird keine Prüfung vorgenommen, die Schnittstelle akzeptiert jeden Request. Entspricht dem Verhalten mit apikey_auth_filter_generic = false, aber pro Schnittstelle konfigurierbar.
API-Schlüssel
Es muss ein HTTP Header mit Schlüssel “Apikey” und dem gültigen API-Schlüssel mitgeschickt werden, damit die Web-Schnittstelle den Request verarbeitet. Entspricht dem Verhalten mit apikey_auth_filter_generic = true, aber pro Schnittstelle konfigurierbar
Token
Es muss ein gültiger Token in der URL der Web-Schnittstelle übermittelt werden. Der Token wird am Anfang der URL nach /url/ erwartet. Der Wertebereich “Komplette URL ”zeigt dies an, indem ein /{apitoken}/ in der URL angezeigt wird.