Zum Inhalt springen

Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 77.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 96.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Schnittstelle ONYX Editor
1 +05 Schnittstelle ONYX Editor
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +ONYX.Systeminformationen.WebHome
Inhalt
... ... @@ -1,24 +2,13 @@
1 -{{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="single"}}
4 -{{layout-cell}}
5 -\\
6 -{{/layout-cell}}
7 -{{/layout-section}}
8 -
9 9  {{layout-section ac:type="two_right_sidebar"}}
10 10  {{layout-cell}}
11 -\\
4 +
12 12  {{/layout-cell}}
13 13  
14 14  {{layout-cell}}
15 -{{scroll-ignore}}
16 16  {{panel title="Inhalt"}}
17 -
18 -
19 -{{toc/}}
9 +{{toc depth="3" start="2"/}}
20 20  {{/panel}}
21 -{{/scroll-ignore}}
22 22  {{/layout-cell}}
23 23  {{/layout-section}}
24 24  
... ... @@ -36,10 +36,10 @@
36 36  @RestParam(name = "params") final Map<String, String> params) {}
37 37  {{/code}}
38 38  
39 -\\
40 40  
41 41  === Parameter saveResult2 ===
42 42  
31 +(% class="wrapped" %)
43 43  |(((
44 44  uniqueId
45 45  )))|(((
... ... @@ -56,10 +56,9 @@
56 56  Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
57 57  )))
58 58  
59 -\\
60 -
61 61  === returnValue saveResult2 ===
62 62  
50 +(% class="wrapped" %)
63 63  |(((
64 64  boolean
65 65  )))|(((
... ... @@ -68,8 +68,6 @@
68 68  
69 69  == Ergebnisse speichern (Legacy) ==
70 70  
71 -\\
72 -
73 73  {{code title="Ergebnisse speichern (Legacy)"}}
74 74  @RestMethod(name = "saveResult")
75 75  public Boolean saveResult(
... ... @@ -77,10 +77,10 @@
77 77  @RestParam(name = "resultFile") final byte[] resultFile) {}
78 78  {{/code}}
79 79  
80 -\\
81 81  
82 82  === Parameter saveResult2 ===
83 83  
69 +(% class="wrapped" %)
84 84  |(((
85 85  uniqueId
86 86  )))|(((
... ... @@ -94,6 +94,7 @@
94 94  
95 95  === returnValue saveResult2 ===
96 96  
83 +(% class="wrapped" %)
97 97  |(((
98 98  boolean
99 99  )))|(((
... ... @@ -100,27 +100,22 @@
100 100  True bei Erfolg, sonst false
101 101  )))
102 102  
103 -\\
104 -
105 105  == Version der Schnittstelle abfragen ==
106 106  
107 -\\
108 -
109 109  {{code title="Version abfragen"}}
110 110  @RestMethod(name = "version")
111 111  public String version() {}
112 112  {{/code}}
113 113  
114 -\\
115 115  
116 116  === Parameter version ===
117 117  
118 118  keine
119 119  
120 -\\
121 121  
122 122  === returnValue saveResult2 ===
123 123  
105 +(% class="wrapped" %)
124 124  |(((
125 125  String
126 126  )))|(((
... ... @@ -127,8 +127,6 @@
127 127  Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
128 128  )))
129 129  
130 -\\
131 -
132 132  == Nutzer löschen ==
133 133  
134 134  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.
... ... @@ -147,6 +147,7 @@
147 147  
148 148  === Parameter deleteUser ===
149 149  
130 +(% class="wrapped" %)
150 150  |(((
151 151  login
152 152  )))|(((
... ... @@ -187,6 +187,7 @@
187 187  
188 188  Löschresultat-Informationen.
189 189  
171 +(% class="wrapped" %)
190 190  |(((
191 191  Key
192 192  )))|(((
... ... @@ -200,202 +200,3 @@
200 200  {{/layout-cell}}
201 201  {{/layout-section}}
202 202  {{/layout}}
203 -{{/sv-translation}}
204 -
205 -{{sv-translation language="en"}}
206 -{{layout}}
207 -{{layout-section ac:type="two_right_sidebar"}}
208 -{{layout-cell}}
209 -\\
210 -{{/layout-cell}}
211 -
212 -{{layout-cell}}
213 -{{scroll-ignore}}
214 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
215 -
216 -
217 -{{toc/}}
218 -{{/panel}}
219 -{{/scroll-ignore}}
220 -{{/layout-cell}}
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 -{{/layout}}
401 -{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -301073196
1 +226230567
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/226230567/Schnittstelle ONYX Editor