GET /<endpoint>/open/confighttp
| Controller | ConfigHttpController |
| Java-Methode | configHttp |
| HTTP-Methode | GET |
| Pfad | /<endpoint>/open/confighttp |
| Erreichbarkeit | extern über den Proxy |
| Content-Type | text/html |
| Query-Parameter | typ (String) |
| Query-Parameter | configurationID (String) |
| Response | String |
Beschreibung
Liefert die HTML-Seite des Konfigurationsdialogs.
Request
typ(String): Typ des PluginsconfigurationID(String): ID der zuvor mit configurationInfo angelegten Konfigurations-Verbindung
Response
Typ: String
HTML-Seite des Dialogs oder 404, wenn keine gültige Verbindung existiert
Die Antwort ist eine HTML-Seite.
Ablauf im Service
- Verwendet
PluginConfiguration:getConfigurationConnection,getUriGetPluginDto. - Die Seite bindet
<endpoint>/open/js/jquery-3.6.0.min.jsund den Quelltext aller lokalen JavaScript-Libraries des Plugins (javascriptLibrariesLocal()) ein. - Sie enthält
<div id="configform_div">, das versteckte Feld.configform_configmit der aktuellen Konfiguration und dasPluginConfigDtoals JSON in<script id="pluginConfigDto">. - Anschließend wird die Konfigurations-Methode des Plugins (
javaScriptMethodeausPluginConfigurationInfoDto) mit dem JSON-String aufgerufen. Der Methodenname muss ein gültiger JavaScript-Bezeichner sein. - Fehlt im
PluginConfigDtodiepluginDtoUri, wird sie auf den externenreloadplugindto-Endpunkt gesetzt.
Fehlerfälle
- 404 Not Found, wenn die Konfigurations-Sitzung fehlt oder abgelaufen ist.
- 500 Internal Server Error, wenn das Plugin keine gültige Konfigurations-Methode angibt.
Siehe auch
POST /open/configurationinfo– Liefert die Informationen welche notwendig sind um einen Konfigurationsdialog zu starten Ist die configurationID gesetzt wird eine Konfiguration gestartet und damit auch die restlichen Endpoints für die Konfiguration aktiviertPOST /open/setconfigurationdata– Sendet alle notwendigen (im ConfigurationInfo) angeforderten Daten im Mode CONFIGMODE_URL an die Plugin-KonfigurationPOST /<endpoint>/api/open/reloadplugindto– Rendern des Plugin-Images, Aufbau eines DTOs zur späteren JavaScript - BearbeitungPOST /open/getconfiguration– Liefert die aktuelle Konfiguration eines Plugins welches sich gerade in einem CONFIGMODE_URL Konfigurationsdialog befindet
ConfigHttpController · REST-Schnittstelle · Referenz-Plugin (Java)