... |
... |
@@ -126,16
+126,21 @@ |
126 |
126 |
|
127 |
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 |
128 |
|
129 |
|
-; name: Pluginname ('Counter') |
|
129 |
+; name |
|
130 |
+: Der Name des aufzurufenden Servlet-Aktions-Plugins, in dem Fall also //Servlet Counter// |
|
131 |
+; client-id |
|
132 |
+: ID des Mandanten, in dem das Zähler-Plugin installiert wurde. Nicht nötig, falls das Plugin als System-Plugin installiert wurde. Es darf nur entweder //client-id// or //project-id// angegeben werden. |
|
133 |
+; project-id |
|
134 |
+: ID eines Formulars, in dem das Zähler-Plugin zur Verfügung steht. Es darf nur entweder //client-id// or //project-id// angegeben werden. |
|
135 |
+; id |
|
136 |
+: UUID des Zählers, auf den zugegriffen werden soll. Existiert der Zähler mit der angegebenen UUID noch nicht, wird ein entsprechender Fehler-Code zurückgeliefert (siehe unten). Es darf nur entwender eine //id// oder ein //counter-name// angegeben werden. |
|
137 |
+; counter-name |
|
138 |
+: Name des Zählers, auf den zugegriffen werden soll. Existiert der Zähler mit dem angegebenen Namen noch nicht, wird ein neuer Zähler erstellt. Es darf nur entwender eine //id// oder ein //counter-name// angegeben werden. |
|
139 |
+; counter-initial |
|
140 |
+: Optional. Initialer Wert des Counters, wenn dieser noch nicht existiert (nur wenn counter-name benutzt wird). |
|
141 |
+; counter-array |
|
142 |
+: Optional. Liefert statt einem JSON-Objekt ein Array zurück. Hier können mehrere Namen oder UUID übergeben werden. |
130 |
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 |
139 |
=== HTTP-Antwort |
140 |
140 |
|
141 |
141 |
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: |