Zum Inhalt springen

Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 89.2
bearbeitet von Carina Enke
am 18.12.2023
Änderungskommentar: Update document after refactoring.
Auf Version 89.1
bearbeitet von Carina Enke
am 08.05.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.7.

Zusammenfassung

Details

Seiteneigenschaften
Übergeordnete Seite
... ... @@ -1,1 +1,0 @@
1 -ONYX.Hilfe.Systeminformationen.WebHome
Inhalt
... ... @@ -1,14 +2,11 @@
1 -{{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="single"}}
4 -{{layout-cell}}
5 -\\
6 -{{/layout-cell}}
3 +{{layout-cell}}{{/layout-cell}}
7 7  {{/layout-section}}
8 8  
9 9  {{layout-section ac:type="two_right_sidebar"}}
10 10  {{layout-cell}}
11 -\\
8 +
12 12  {{/layout-cell}}
13 13  
14 14  {{layout-cell}}
... ... @@ -19,6 +19,10 @@
19 19  {{toc/}}
20 20  {{/panel}}
21 21  {{/scroll-ignore}}
19 +
20 +
21 +
22 +
22 22  {{/layout-cell}}
23 23  {{/layout-section}}
24 24  
... ... @@ -36,20 +36,19 @@
36 36  @RestParam(name = "params") final Map<String, String> params) {}
37 37  {{/code}}
38 38  
39 -\\
40 +
40 40  
41 41  === Parameter saveResult2 ===
42 42  
43 -(% class="wrapped" %)
44 44  |(((
45 45  uniqueId
46 46  )))|(((
47 -Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben.
47 +Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
48 48  )))
49 49  |(((
50 50  resultFile
51 51  )))|(((
52 -Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents)
52 +Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
53 53  )))
54 54  |(((
55 55  params
... ... @@ -57,11 +57,10 @@
57 57  Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
58 58  )))
59 59  
60 -\\
60 +
61 61  
62 62  === returnValue saveResult2 ===
63 63  
64 -(% class="wrapped" %)
65 65  |(((
66 66  boolean
67 67  )))|(((
... ... @@ -70,7 +70,7 @@
70 70  
71 71  == Ergebnisse speichern (Legacy) ==
72 72  
73 -\\
72 +
74 74  
75 75  {{code title="Ergebnisse speichern (Legacy)"}}
76 76  @RestMethod(name = "saveResult")
... ... @@ -79,25 +79,23 @@
79 79  @RestParam(name = "resultFile") final byte[] resultFile) {}
80 80  {{/code}}
81 81  
82 -\\
81 +
83 83  
84 84  === Parameter saveResult2 ===
85 85  
86 -(% class="wrapped" %)
87 87  |(((
88 88  uniqueId
89 89  )))|(((
90 -Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben.
88 +Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
91 91  )))
92 92  |(((
93 93  resultFile
94 94  )))|(((
95 -Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents)
93 +Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
96 96  )))
97 97  
98 98  === returnValue saveResult2 ===
99 99  
100 -(% class="wrapped" %)
101 101  |(((
102 102  boolean
103 103  )))|(((
... ... @@ -104,11 +104,11 @@
104 104  True bei Erfolg, sonst false
105 105  )))
106 106  
107 -\\
104 +
108 108  
109 109  == Version der Schnittstelle abfragen ==
110 110  
111 -\\
108 +
112 112  
113 113  {{code title="Version abfragen"}}
114 114  @RestMethod(name = "version")
... ... @@ -115,17 +115,16 @@
115 115  public String version() {}
116 116  {{/code}}
117 117  
118 -\\
115 +
119 119  
120 120  === Parameter version ===
121 121  
122 122  keine
123 123  
124 -\\
121 +
125 125  
126 126  === returnValue saveResult2 ===
127 127  
128 -(% class="wrapped" %)
129 129  |(((
130 130  String
131 131  )))|(((
... ... @@ -132,7 +132,7 @@
132 132  Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
133 133  )))
134 134  
135 -\\
131 +
136 136  
137 137  == Nutzer löschen ==
138 138  
... ... @@ -152,7 +152,6 @@
152 152  
153 153  === Parameter deleteUser ===
154 154  
155 -(% class="wrapped" %)
156 156  |(((
157 157  login
158 158  )))|(((
... ... @@ -166,12 +166,12 @@
166 166  |(((
167 167  repo
168 168  )))|(((
169 -ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird.
164 +ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird
170 170  )))
171 171  |(((
172 172  property
173 173  )))|(((
174 -Selektionskriterium der zu löschenden Nutzer. Wenn "uid", dann wird nach dem global gültigen Nutzer-Identifier (Shibboleth-Kriterium) gefiltert, sonst nach den Nutzernamen, die vom LMS in Verbindung mit dem ONYX Editor intern genutzt werden.
169 +Selektionskriterium der zu löschenden Nutzer. Wenn "uid", dann wird nach dem gloabl gültigem Nutzer-Identifier (Shibboleth-Kriterium) gefiltert, sonst nach den Nutzernamen, die vom LMS in Verbindung mit dem ONYX Editor intern genutzt werden.
175 175  )))
176 176  |(((
177 177  values
... ... @@ -193,7 +193,6 @@
193 193  
194 194  Löschresultat-Informationen.
195 195  
196 -(% class="wrapped" %)
197 197  |(((
198 198  Key
199 199  )))|(((
... ... @@ -207,202 +207,3 @@
207 207  {{/layout-cell}}
208 208  {{/layout-section}}
209 209  {{/layout}}
210 -{{/sv-translation}}
211 -
212 -{{sv-translation language="en"}}
213 -{{layout}}
214 -{{layout-section ac:type="two_right_sidebar"}}
215 -{{layout-cell}}
216 -\\
217 -{{/layout-cell}}
218 -
219 -{{layout-cell}}
220 -{{scroll-ignore}}
221 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
222 -
223 -
224 -{{toc/}}
225 -{{/panel}}
226 -{{/scroll-ignore}}
227 -{{/layout-cell}}
228 -{{/layout-section}}
229 -
230 -{{layout-section ac:type="single"}}
231 -{{layout-cell}}
232 -== Save results ==
233 -
234 -With the ONYX Editor, system independent tests may be published. If users perform these tests, the result will be transferred back to the ONYX Editor, which saves it. The ONYX Editor provides the following REST interfaces:
235 -
236 -{{code title="Save results"}}
237 -@RestMethod(name = "saveResult2")
238 -public Boolean saveResult(
239 -@RestParam(name = "uniqueId") final String uniqueId,
240 -@RestParam(name = "resultFile") final byte[] resultFile,
241 -@RestParam(name = "params") final Map<String, String> params) {}
242 -{{/code}}
243 -
244 -\\
245 -
246 -=== Parameter saveResult2 ===
247 -
248 -|(((
249 -uniqueId
250 -)))|(((
251 -Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
252 -)))
253 -|(((
254 -resultFile
255 -)))|(((
256 -Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
257 -)))
258 -|(((
259 -params
260 -)))|(((
261 -Generic parameters. These are currently only stored without further processing.
262 -)))
263 -
264 -\\
265 -
266 -=== returnValue saveResult2 ===
267 -
268 -|(((
269 -boolean
270 -)))|(((
271 -True if successful, otherwise false
272 -)))
273 -
274 -== Save results (legacy) ==
275 -
276 -\\
277 -
278 -{{code title="Save results (legacy)"}}
279 -@RestMethod(name = "saveResult")
280 -public Boolean saveResult(
281 -@RestParam(name = "uniqueId") final String uniqueId,
282 -@RestParam(name = "resultFile") final byte[] resultFile) {}
283 -{{/code}}
284 -
285 -\\
286 -
287 -=== Parameter saveResult2 ===
288 -
289 -|(((
290 -uniqueId
291 -)))|(((
292 -Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
293 -)))
294 -|(((
295 -resultFile
296 -)))|(((
297 -Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
298 -)))
299 -
300 -=== returnValue saveResult2 ===
301 -
302 -|(((
303 -boolean
304 -)))|(((
305 -True if successful, otherwise false
306 -)))
307 -
308 -\\
309 -
310 -== Query interface version ==
311 -
312 -\\
313 -
314 -{{code title="Query version"}}
315 -@RestMethod(name = "version")
316 -public String version() {}
317 -{{/code}}
318 -
319 -\\
320 -
321 -=== Parameter version ===
322 -
323 -None
324 -
325 -\\
326 -
327 -=== returnValue saveResult2 ===
328 -
329 -|(((
330 -String
331 -)))|(((
332 -REST interface version, currently always "1.0 (ONYX Editor version)"
333 -)))
334 -
335 -\\
336 -
337 -== Delete user ==
338 -
339 -The ONYX Editor can be coupled to an LMS with the LMS being the user data management system. If users are deleted from the LMS, all related data (e. g. personal user settings) should also be deleted from the ONYX Editor.
340 -
341 -{{code title="Delete user"}}
342 -@RestMethod
343 -public Map<String, String> deleteUser(
344 - @RestParam(name = "login") final String login,
345 - @RestParam(name = "password") final String password,
346 - @RestParam(name = "repo") final String repo,
347 - @RestParam(name = "property") final String property,
348 - @RestParam(name = "values") final ArrayList<String> values,
349 - @RestParam(name = "reason") final String reason,
350 - @RestParam(name = "params") final Map<String, String> params) {}
351 -{{/code}}
352 -
353 -=== Parameter deleteUser ===
354 -
355 -|(((
356 -login
357 -)))|(((
358 -User name of an ONYX Editor admin user who has the right to delete other users.
359 -)))
360 -|(((
361 -password
362 -)))|(((
363 -Password of this ONYX Editor admin user.
364 -)))
365 -|(((
366 -repo
367 -)))|(((
368 -ID of the LMS repository as it is already configured in the LMS and used for communication with the ONYX Editor.
369 -)))
370 -|(((
371 -property
372 -)))|(((
373 -Selection criterion for the users to be deleted. If "uid", filtering is done according to the globally valid user identifier (Shibboleth criterion). Otherwise, the filtering is done according to the user names used internally by the LMS in conjunction with the ONYX Editor.
374 -)))
375 -|(((
376 -values
377 -)))|(((
378 -List of values to filter by, for example, list of user names.
379 -)))
380 -|(((
381 -reason
382 -)))|(((
383 -Reason for deletion. Will be included in the deletion log.
384 -)))
385 -|(((
386 -params
387 -)))|(((
388 -Currently not used
389 -)))
390 -
391 -=== returnValue deleteUser ===
392 -
393 -Deletion result information.
394 -
395 -|(((
396 -Key
397 -)))|(((
398 -The values as specified in the _values_ parameter
399 -)))
400 -|(((
401 -Value
402 -)))|(((
403 -Deletion result (e. g _NOT FOUND_, _ERROR:xyz_, ...)
404 -)))
405 -{{/layout-cell}}
406 -{{/layout-section}}
407 -{{/layout}}
408 -{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -226230567
1 +226230706
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226230567/Schnittstelle ONYX Editor
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226230706/Schnittstelle ONYX Editor