Zum Inhalt springen

Wiki-Quellcode von Schnittstelle ONYX Editor

Version 41.1 von Carina Enke am 20.10.2023
Zeige letzte Bearbeiter
1 {{sv-translation language="de"}}
2 {{layout}}
3 {{layout-section ac:type="single"}}
4 {{layout-cell}}
5 \\
6
7 {{details}}
8 (% class="wrapped" %)
9 |=(((
10 Verantwortlicher
11 )))|(((
12 \\
13 )))
14 |=(% colspan="1" %)(% colspan="1" %)
15 (((
16 Status
17 )))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
18 (((
19 (% class="content-wrapper" %)
20 (((
21 {{sv-metadata type="workflow-status"/}}
22
23 {{status colour="Green" title="Fertig"/}}
24 )))
25 )))
26 |=(% colspan="1" %)(% colspan="1" %)
27 (((
28 Varianten
29 )))|(% colspan="1" %)(% colspan="1" %)
30 (((
31 (% class="content-wrapper" %)
32 (((
33 {{sv-metadata type="variants"/}}
34 )))
35 )))
36 |=(% colspan="1" %)(% colspan="1" %)
37 (((
38 Attribute
39 )))|(% colspan="1" %)(% colspan="1" %)
40 (((
41 (% class="content-wrapper" %)
42 (((
43 {{sv-metadata type="attributes"/}}
44 )))
45 )))
46 |=(% colspan="1" %)(% colspan="1" %)
47 (((
48 Pagekey
49 )))|(% colspan="1" %)(% colspan="1" %)
50 (((
51 (% class="content-wrapper" %)
52 (((
53 {{sv-metadata type="pagekey"/}}
54 )))
55 )))
56 |=(% colspan="1" %)(% colspan="1" %)
57 (((
58 Übersetzung
59 )))|(% colspan="1" %)(% colspan="1" %)
60 (((
61 (% class="content-wrapper" %)
62 (((
63 Interface ONYX Editor 
64
65 {{status colour="Green" title="fertig"/}}
66 )))
67 )))
68 |=(% colspan="1" %)(% colspan="1" %)
69 (((
70 TODOs
71 )))|(% colspan="1" %)(% colspan="1" %)
72 (((
73 (% class="content-wrapper" %)
74 (((
75 Stand der Infos auf Ticket ONYX-4213 vom Aug 2018
76
77 (% class="task-list" %)
78 (((
79 {{task reference="/Tasks/Task_1" status="Done"}}
80 carina {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-czKhe"/}}Neue Seite bitte übersetzen
81 {{/task}}
82 )))
83 )))
84 )))
85 {{/details}}
86 {{/layout-cell}}
87 {{/layout-section}}
88
89 {{layout-section ac:type="two_right_sidebar"}}
90 {{layout-cell}}
91 \\
92 {{/layout-cell}}
93
94 {{layout-cell}}
95 {{scroll-ignore}}
96 {{panel title="Inhalt"}}
97
98
99 {{toc/}}
100 {{/panel}}
101 {{/scroll-ignore}}
102 {{/layout-cell}}
103 {{/layout-section}}
104
105 {{layout-section ac:type="single"}}
106 {{layout-cell}}
107 == Ergebnisse speichern ==
108
109 Der ONYX Editor kann Tests für eine freie Durchführung publizieren. Führen Nutzer diese Tests durch, wird das Ergebnis zurück an den ONYX Editor übertragen, welcher es speichert. Dazu bietet der ONYX Editor folgende REST-Schnittstellen an:
110
111 {{code title="Ergebnisse speichern"}}
112 @RestMethod(name = "saveResult2")
113 public Boolean saveResult(
114 @RestParam(name = "uniqueId") final String uniqueId,
115 @RestParam(name = "resultFile") final byte[] resultFile,
116 @RestParam(name = "params") final Map<String, String> params) {}
117 {{/code}}
118
119 \\
120
121 === Parameter saveResult2 ===
122
123 (% class="wrapped" %)
124 |(((
125 uniqueId
126 )))|(((
127 Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben.
128 )))
129 |(((
130 resultFile
131 )))|(((
132 Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents)
133 )))
134 |(((
135 params
136 )))|(((
137 Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
138 )))
139
140 \\
141
142 === returnValue saveResult2 ===
143
144 (% class="wrapped" %)
145 |(((
146 boolean
147 )))|(((
148 True bei Erfolg, sonst false
149 )))
150
151 == Ergebnisse speichern (Legacy) ==
152
153 \\
154
155 {{code title="Ergebnisse speichern (Legacy)"}}
156 @RestMethod(name = "saveResult")
157 public Boolean saveResult(
158 @RestParam(name = "uniqueId") final String uniqueId,
159 @RestParam(name = "resultFile") final byte[] resultFile) {}
160 {{/code}}
161
162 \\
163
164 === Parameter saveResult2 ===
165
166 (% class="wrapped" %)
167 |(((
168 uniqueId
169 )))|(((
170 Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben.
171 )))
172 |(((
173 resultFile
174 )))|(((
175 Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents)
176 )))
177
178 === returnValue saveResult2 ===
179
180 (% class="wrapped" %)
181 |(((
182 boolean
183 )))|(((
184 True bei Erfolg, sonst false
185 )))
186
187 \\
188
189 == Version der Schnittstelle abfragen ==
190
191 \\
192
193 {{code title="Version abfragen"}}
194 @RestMethod(name = "version")
195 public String version() {}
196 {{/code}}
197
198 \\
199
200 === Parameter version ===
201
202 keine
203
204 \\
205
206 === returnValue saveResult2 ===
207
208 (% class="wrapped" %)
209 |(((
210 String
211 )))|(((
212 Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
213 )))
214
215 \\
216
217 == Nutzer löschen ==
218
219 Der ONYX Editor kann an ein LMS gekoppelt werden, so dass das LMS das nutzerdatenführende System ist. Werden Nutzer im LMS gelöscht, so sollten alle zugehörigen Daten (bspw. die persönlichen Einstellungen des Nutzers) auch im ONYX Editor gelöscht werden.
220
221 {{code title="Nutzer löschen"}}
222 @RestMethod
223 public Map<String, String> deleteUser(
224 @RestParam(name = "login") final String login,
225 @RestParam(name = "password") final String password,
226 @RestParam(name = "repo") final String repo,
227 @RestParam(name = "property") final String property,
228 @RestParam(name = "values") final ArrayList<String> values,
229 @RestParam(name = "reason") final String reason,
230 @RestParam(name = "params") final Map<String, String> params) {}
231 {{/code}}
232
233 === Parameter deleteUser ===
234
235 (% class="wrapped" %)
236 |(((
237 login
238 )))|(((
239 Username eines ONYX-Editor-Admin-Nutzers, der das Recht hat, andere Nutzer zu löschen.
240 )))
241 |(((
242 password
243 )))|(((
244 Passwort dieses ONYX-Editor-Admin-Nutzers.
245 )))
246 |(((
247 repo
248 )))|(((
249 ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird.
250 )))
251 |(((
252 property
253 )))|(((
254 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.
255 )))
256 |(((
257 values
258 )))|(((
259 Liste der Werte, nach denen gefiltert wird, bspw. Liste der Nutzernamen.
260 )))
261 |(((
262 reason
263 )))|(((
264 Lösch-Grund. Wird mit ins Lösch-Log geschrieben.
265 )))
266 |(((
267 params
268 )))|(((
269 Aktuell nicht genutzt
270 )))
271
272 === returnValue deleteUser ===
273
274 Löschresultat-Informationen.
275
276 (% class="wrapped" %)
277 |(((
278 Key
279 )))|(((
280 Die Values, wie im Parameter _values_ angegeben
281 )))
282 |(((
283 Value
284 )))|(((
285 Löschresultat (bspw. _NOT FOUND_, _ERROR:xyz_, ...)
286 )))
287 {{/layout-cell}}
288 {{/layout-section}}
289 {{/layout}}
290 {{/sv-translation}}
291
292 {{sv-translation language="en"}}
293 {{layout}}
294 {{layout-section ac:type="two_right_sidebar"}}
295 {{layout-cell}}
296 \\
297 {{/layout-cell}}
298
299 {{layout-cell}}
300 {{scroll-ignore}}
301 {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
302
303
304 {{toc/}}
305 {{/panel}}
306 {{/scroll-ignore}}
307 {{/layout-cell}}
308 {{/layout-section}}
309
310 {{layout-section ac:type="single"}}
311 {{layout-cell}}
312 == Save results ==
313
314 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:
315
316 {{code title="Save results"}}
317 @RestMethod(name = "saveResult2")
318 public Boolean saveResult(
319 @RestParam(name = "uniqueId") final String uniqueId,
320 @RestParam(name = "resultFile") final byte[] resultFile,
321 @RestParam(name = "params") final Map<String, String> params) {}
322 {{/code}}
323
324 \\
325
326 === Parameter saveResult2 ===
327
328 |(((
329 uniqueId
330 )))|(((
331 Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
332 )))
333 |(((
334 resultFile
335 )))|(((
336 Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
337 )))
338 |(((
339 params
340 )))|(((
341 Generic parameters. These are currently only stored without further processing.
342 )))
343
344 \\
345
346 === returnValue saveResult2 ===
347
348 |(((
349 boolean
350 )))|(((
351 True if successful, otherwise false
352 )))
353
354 == Save results (legacy) ==
355
356 \\
357
358 {{code title="Save results (legacy)"}}
359 @RestMethod(name = "saveResult")
360 public Boolean saveResult(
361 @RestParam(name = "uniqueId") final String uniqueId,
362 @RestParam(name = "resultFile") final byte[] resultFile) {}
363 {{/code}}
364
365 \\
366
367 === Parameter saveResult2 ===
368
369 |(((
370 uniqueId
371 )))|(((
372 Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
373 )))
374 |(((
375 resultFile
376 )))|(((
377 Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
378 )))
379
380 === returnValue saveResult2 ===
381
382 |(((
383 boolean
384 )))|(((
385 True if successful, otherwise false
386 )))
387
388 \\
389
390 == Query interface version ==
391
392 \\
393
394 {{code title="Query version"}}
395 @RestMethod(name = "version")
396 public String version() {}
397 {{/code}}
398
399 \\
400
401 === Parameter version ===
402
403 None
404
405 \\
406
407 === returnValue saveResult2 ===
408
409 |(((
410 String
411 )))|(((
412 REST interface version, currently always "1.0 (ONYX Editor version)"
413 )))
414
415 \\
416
417 == Delete user ==
418
419 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.
420
421 {{code title="Delete user"}}
422 @RestMethod
423 public Map<String, String> deleteUser(
424 @RestParam(name = "login") final String login,
425 @RestParam(name = "password") final String password,
426 @RestParam(name = "repo") final String repo,
427 @RestParam(name = "property") final String property,
428 @RestParam(name = "values") final ArrayList<String> values,
429 @RestParam(name = "reason") final String reason,
430 @RestParam(name = "params") final Map<String, String> params) {}
431 {{/code}}
432
433 === Parameter deleteUser ===
434
435 |(((
436 login
437 )))|(((
438 User name of an ONYX Editor admin user who has the right to delete other users.
439 )))
440 |(((
441 password
442 )))|(((
443 Password of this ONYX Editor admin user.
444 )))
445 |(((
446 repo
447 )))|(((
448 ID of the LMS repository as it is already configured in the LMS and used for communication with the ONYX Editor.
449 )))
450 |(((
451 property
452 )))|(((
453 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.
454 )))
455 |(((
456 values
457 )))|(((
458 List of values to filter by, for example, list of user names.
459 )))
460 |(((
461 reason
462 )))|(((
463 Reason for deletion. Will be included in the deletion log.
464 )))
465 |(((
466 params
467 )))|(((
468 Currently not used
469 )))
470
471 === returnValue deleteUser ===
472
473 Deletion result information.
474
475 |(((
476 Key
477 )))|(((
478 The values as specified in the _values_ parameter
479 )))
480 |(((
481 Value
482 )))|(((
483 Deletion result (e. g _NOT FOUND_, _ERROR:xyz_, ...)
484 )))
485 {{/layout-cell}}
486 {{/layout-section}}
487 {{/layout}}
488 {{/sv-translation}}