POST /open/getvars
| Controller | ApiController |
| Java-Methode | getVars |
| HTTP-Methode | POST |
| Pfad | /open/getvars |
| Erreichbarkeit | nur im Docker-Netzwerk |
| Request-Body | PluginRequestDto |
| Response | Vector<String> |
Beschreibung
Liefert eine Liste aller Variablen welche als Dataset benötigt werden.
Request
Body: PluginRequestDto
| Feld | Typ | ausgewertet | Bedeutung |
|---|---|---|---|
typ |
String | ja | Typ des Plugins |
name |
String | ja | Name des Plugins in der Frage |
config |
String | ja | Konfigurationsstring des Plugins |
params |
String | nein | Parameter für die Antworterzeugung |
q |
PluginQuestionDto | nein | Frage wo das Plugin eingebettet ist |
pluginMaximaCalcMode |
PluginMaximaCalcModeDto | nein | Art der Berechnung |
Response
Typ: Vector<String>
Liste aller Variablen des Plugins
Ablauf im Service
- Erzeugt über
PluginConfiguration.createPluginService(typ, name, config)eine neue Plugin-Instanz und ruft auf:getVars.
Fehlerfälle
- 404 Not Found, wenn der Plugin-Typ nicht registriert ist oder das Plugin nicht erzeugt werden kann („Plugin vom Typ … kann nicht erzeugt werden”).
Beispiel-Request
JSON-Gerüst aus den Feldern des DTOs, Werte sind Platzhalter:
{
"typ": "<typ>",
"name": "<name>",
"config": "<config>",
"params": "<params>",
"q": {
"…": "PluginQuestionDto"
},
"pluginMaximaCalcMode": {
"…": "PluginMaximaCalcModeDto"
}
}
Siehe auch
POST /open/generatedatasets– Liefert alle Datensätze, welche für das Plugin in der Frage vorhanden sein sollten