Zum Inhalt springen

Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 73.1
bearbeitet von Carina Enke
am 19.05.2020
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 9.0.
Auf Version 78.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
Inhalt
... ... @@ -1,94 +1,12 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 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-mSKyV"/}}Neue Seite bitte übersetzen
81 -{{/task}}
82 -)))
83 -)))
84 -)))
85 -{{/details}}
86 -{{/layout-cell}}
4 +{{layout-cell}}{{/layout-cell}}
87 87  {{/layout-section}}
88 88  
89 89  {{layout-section ac:type="two_right_sidebar"}}
90 90  {{layout-cell}}
91 -\\
9 +
92 92  {{/layout-cell}}
93 93  
94 94  {{layout-cell}}
... ... @@ -99,6 +99,10 @@
99 99  {{toc/}}
100 100  {{/panel}}
101 101  {{/scroll-ignore}}
20 +
21 +
22 +
23 +
102 102  {{/layout-cell}}
103 103  {{/layout-section}}
104 104  
... ... @@ -116,20 +116,19 @@
116 116  @RestParam(name = "params") final Map<String, String> params) {}
117 117  {{/code}}
118 118  
119 -\\
41 +
120 120  
121 121  === Parameter saveResult2 ===
122 122  
123 -(% class="wrapped" %)
124 124  |(((
125 125  uniqueId
126 126  )))|(((
127 -Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben.
48 +Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
128 128  )))
129 129  |(((
130 130  resultFile
131 131  )))|(((
132 -Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents)
53 +Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
133 133  )))
134 134  |(((
135 135  params
... ... @@ -137,11 +137,10 @@
137 137  Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
138 138  )))
139 139  
140 -\\
61 +
141 141  
142 142  === returnValue saveResult2 ===
143 143  
144 -(% class="wrapped" %)
145 145  |(((
146 146  boolean
147 147  )))|(((
... ... @@ -150,7 +150,7 @@
150 150  
151 151  == Ergebnisse speichern (Legacy) ==
152 152  
153 -\\
73 +
154 154  
155 155  {{code title="Ergebnisse speichern (Legacy)"}}
156 156  @RestMethod(name = "saveResult")
... ... @@ -159,25 +159,23 @@
159 159  @RestParam(name = "resultFile") final byte[] resultFile) {}
160 160  {{/code}}
161 161  
162 -\\
82 +
163 163  
164 164  === Parameter saveResult2 ===
165 165  
166 -(% class="wrapped" %)
167 167  |(((
168 168  uniqueId
169 169  )))|(((
170 -Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben.
89 +Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
171 171  )))
172 172  |(((
173 173  resultFile
174 174  )))|(((
175 -Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents)
94 +Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
176 176  )))
177 177  
178 178  === returnValue saveResult2 ===
179 179  
180 -(% class="wrapped" %)
181 181  |(((
182 182  boolean
183 183  )))|(((
... ... @@ -184,11 +184,11 @@
184 184  True bei Erfolg, sonst false
185 185  )))
186 186  
187 -\\
105 +
188 188  
189 189  == Version der Schnittstelle abfragen ==
190 190  
191 -\\
109 +
192 192  
193 193  {{code title="Version abfragen"}}
194 194  @RestMethod(name = "version")
... ... @@ -195,17 +195,16 @@
195 195  public String version() {}
196 196  {{/code}}
197 197  
198 -\\
116 +
199 199  
200 200  === Parameter version ===
201 201  
202 202  keine
203 203  
204 -\\
122 +
205 205  
206 206  === returnValue saveResult2 ===
207 207  
208 -(% class="wrapped" %)
209 209  |(((
210 210  String
211 211  )))|(((
... ... @@ -212,7 +212,7 @@
212 212  Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
213 213  )))
214 214  
215 -\\
132 +
216 216  
217 217  == Nutzer löschen ==
218 218  
... ... @@ -232,7 +232,6 @@
232 232  
233 233  === Parameter deleteUser ===
234 234  
235 -(% class="wrapped" %)
236 236  |(((
237 237  login
238 238  )))|(((
... ... @@ -246,12 +246,12 @@
246 246  |(((
247 247  repo
248 248  )))|(((
249 -ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird.
165 +ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird
250 250  )))
251 251  |(((
252 252  property
253 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.
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.
255 255  )))
256 256  |(((
257 257  values
... ... @@ -273,7 +273,6 @@
273 273  
274 274  Löschresultat-Informationen.
275 275  
276 -(% class="wrapped" %)
277 277  |(((
278 278  Key
279 279  )))|(((
... ... @@ -293,196 +293,22 @@
293 293  {{layout}}
294 294  {{layout-section ac:type="two_right_sidebar"}}
295 295  {{layout-cell}}
296 -\\
211 +
297 297  {{/layout-cell}}
298 298  
299 299  {{layout-cell}}
300 300  {{scroll-ignore}}
301 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
216 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="On this page"}}
302 302  
303 303  
304 304  {{toc/}}
220 +
221 +**related pages**
222 +
223 +* pages
305 305  {{/panel}}
306 306  {{/scroll-ignore}}
307 307  {{/layout-cell}}
308 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 487  {{/layout}}
488 488  {{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -337413505
1 +234979411
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/337413505/Schnittstelle ONYX Editor
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/234979411/Schnittstelle ONYX Editor