| ... |
... |
@@ -107,7
+107,7 @@ |
| 107 |
107 |
Nach Installation des Plugins ist eine neue Servlet-Aktion verfügbar, mit der auf den aktuellen Wert eines Zähler zugegriffen werden kann. Dies ist etwa nützlich, wenn aus dem Formular heraus ein Zählwert per AJAX-Anfrage abgerufen werden soll. Die URL für das Servlet baut sich nach dem folgenden Schema auf: |
| 108 |
108 |
|
| 109 |
109 |
{{code}} |
| 110 |
|
-https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&client-id=<MANDANT_ID>&id=<ZAEHLER_UUID> |
|
110 |
+https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&client-id=<Mandant-ID>&id=<Zähler-UUID> |
| 111 |
111 |
{{/code}} |
| 112 |
112 |
|
| 113 |
113 |
Falls also etwa FORMCYCLE lokal unter dem Pfad //xima-formcycle// installiert wurde, der Zähler in einem Formular des Mandanten mit der ID //1// verwendet wird und die UUID //bc49d3b0-f869-4e59-864e-ddcc2925ed63// besitzt, dann lautet die URL: |
| ... |
... |
@@ -119,9
+119,25 @@ |
| 119 |
119 |
Alternativ ist es auch möglich, statt der //client-id// die ID des Formulars zu verwenden. Diese IDs lediglich verwendet, um das Servlet-Aktions-Plugin zu bestimmen, welches ausgeführt werden soll, und werden von diesem konkreten Plugin nicht ausgewertet: |
| 120 |
120 |
|
| 121 |
121 |
{{code}} |
| 122 |
|
-https://<HOST>/<FORMCYCLE_CONTEXT_PATH>/plugin?name=Servlet%20Counter&project-id=<FORMULAR_ID>&id=<ZAEHLER_UUID> |
|
122 |
+https://<Host>/<FORMCYCLE-Kontextpfad>/plugin?name=Servlet%20Counter&project-id=<Formular-ID>&id=<Zähler-UUID> |
| 123 |
123 |
{{/code}} |
| 124 |
124 |
|
|
125 |
+=== HTTP-Parameter |
|
126 |
+ |
|
127 |
+Zusätzlich zu den oben genannten Parametern gibt es noch weitere Parameter, die an die URL angehängt werden können. Im Folgenden werden alle verfügbaren Parameter kurz erläutert. |
|
128 |
+ |
|
129 |
+; name: Pluginname ('Counter') |
|
130 |
+ |
|
131 |
+project-id: Projekt-ID |
|
132 |
+ |
|
133 |
+id oder counter-name: UUID oder Name des Counters. Wird eine UUID angegeben und existiert der Counter noch nicht, wird ein entsprechender Fehler-Code zurückgeliefert. Wird ein Name angegeben und existiert der Counter noch nicht, wird ein neuer Counter erstellt. |
|
134 |
+ |
|
135 |
+counter-initial: Initialer Wert des Counters, wenn dieser noch nicht existiert (nur wenn counter-name benutzt wird). |
|
136 |
+ |
|
137 |
+counter-array: Liefert statt einem JSON-Objekt ein Array zurück. Hier können mehrere Namen oder UUID übergeben werden. |
|
138 |
+ |
|
139 |
+=== HTTP-Antwort |
|
140 |
+ |
| 125 |
125 |
Nach Ausführung des Servlet-Aktions-Plugin wird das Ergebnis als JSON-Objekt zurückgeliefert, siehe hierzu auch die Abbildung. Dieses JSON-Objekt hat die folgenden Einträge: |
| 126 |
126 |
|
| 127 |
127 |
; Status |