Zum Inhalt springen

Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 13.02.2024
Von 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.
Auf 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.

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,14 +1,12 @@
1 1  {{sv-translation language="de"}}
2 2  {{layout}}
3 3  {{layout-section ac:type="single"}}
4 -{{layout-cell}}
5 -\\
6 -{{/layout-cell}}
4 +{{layout-cell}}{{/layout-cell}}
7 7  {{/layout-section}}
8 8  
9 9  {{layout-section ac:type="two_right_sidebar"}}
10 10  {{layout-cell}}
11 -\\
9 +
12 12  {{/layout-cell}}
13 13  
14 14  {{layout-cell}}
... ... @@ -19,6 +19,10 @@
19 19  {{toc/}}
20 20  {{/panel}}
21 21  {{/scroll-ignore}}
20 +
21 +
22 +
23 +
22 22  {{/layout-cell}}
23 23  {{/layout-section}}
24 24  
... ... @@ -36,7 +36,7 @@
36 36  @RestParam(name = "params") final Map<String, String> params) {}
37 37  {{/code}}
38 38  
39 -\\
41 +
40 40  
41 41  === Parameter saveResult2 ===
42 42  
... ... @@ -43,12 +43,12 @@
43 43  |(((
44 44  uniqueId
45 45  )))|(((
46 -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
47 47  )))
48 48  |(((
49 49  resultFile
50 50  )))|(((
51 -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
52 52  )))
53 53  |(((
54 54  params
... ... @@ -56,7 +56,7 @@
56 56  Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
57 57  )))
58 58  
59 -\\
61 +
60 60  
61 61  === returnValue saveResult2 ===
62 62  
... ... @@ -68,7 +68,7 @@
68 68  
69 69  == Ergebnisse speichern (Legacy) ==
70 70  
71 -\\
73 +
72 72  
73 73  {{code title="Ergebnisse speichern (Legacy)"}}
74 74  @RestMethod(name = "saveResult")
... ... @@ -77,7 +77,7 @@
77 77  @RestParam(name = "resultFile") final byte[] resultFile) {}
78 78  {{/code}}
79 79  
80 -\\
82 +
81 81  
82 82  === Parameter saveResult2 ===
83 83  
... ... @@ -84,12 +84,12 @@
84 84  |(((
85 85  uniqueId
86 86  )))|(((
87 -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
88 88  )))
89 89  |(((
90 90  resultFile
91 91  )))|(((
92 -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
93 93  )))
94 94  
95 95  === returnValue saveResult2 ===
... ... @@ -100,11 +100,11 @@
100 100  True bei Erfolg, sonst false
101 101  )))
102 102  
103 -\\
105 +
104 104  
105 105  == Version der Schnittstelle abfragen ==
106 106  
107 -\\
109 +
108 108  
109 109  {{code title="Version abfragen"}}
110 110  @RestMethod(name = "version")
... ... @@ -111,13 +111,13 @@
111 111  public String version() {}
112 112  {{/code}}
113 113  
114 -\\
116 +
115 115  
116 116  === Parameter version ===
117 117  
118 118  keine
119 119  
120 -\\
122 +
121 121  
122 122  === returnValue saveResult2 ===
123 123  
... ... @@ -127,7 +127,7 @@
127 127  Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
128 128  )))
129 129  
130 -\\
132 +
131 131  
132 132  == Nutzer löschen ==
133 133  
... ... @@ -160,12 +160,12 @@
160 160  |(((
161 161  repo
162 162  )))|(((
163 -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
164 164  )))
165 165  |(((
166 166  property
167 167  )))|(((
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.
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.
169 169  )))
170 170  |(((
171 171  values
... ... @@ -206,196 +206,22 @@
206 206  {{layout}}
207 207  {{layout-section ac:type="two_right_sidebar"}}
208 208  {{layout-cell}}
209 -\\
211 +
210 210  {{/layout-cell}}
211 211  
212 212  {{layout-cell}}
213 213  {{scroll-ignore}}
214 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
216 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="On this page"}}
215 215  
216 216  
217 217  {{toc/}}
220 +
221 +**related pages**
222 +
223 +* pages
218 218  {{/panel}}
219 219  {{/scroll-ignore}}
220 220  {{/layout-cell}}
221 221  {{/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}}
400 400  {{/layout}}
401 401  {{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -301073196
1 +234979411
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/301073196/Schnittstelle ONYX Editor
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/234979411/Schnittstelle ONYX Editor