Zum Inhalt springen

Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 79.1
bearbeitet von Carina Enke
am 08.05.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.7.
Auf Version 76.1
bearbeitet von Carina Enke
am 07.06.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.7.

Zusammenfassung

Details

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