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 95.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,9 +2,4 @@
1 -{{sv-translation language="de"}}
2 2  {{layout}}
3 -{{layout-section ac:type="single"}}
4 -{{layout-cell}}{{/layout-cell}}
5 -{{/layout-section}}
6 -
7 7  {{layout-section ac:type="two_right_sidebar"}}
8 8  {{layout-cell}}
9 9  
... ... @@ -10,17 +10,9 @@
10 10  {{/layout-cell}}
11 11  
12 12  {{layout-cell}}
13 -{{scroll-ignore}}
14 14  {{panel title="Inhalt"}}
15 -
16 -
17 -{{toc/}}
9 +{{toc depth="3" start="2"/}}
18 18  {{/panel}}
19 -{{/scroll-ignore}}
20 -
21 -
22 -
23 -
24 24  {{/layout-cell}}
25 25  {{/layout-section}}
26 26  
... ... @@ -38,19 +38,19 @@
38 38  @RestParam(name = "params") final Map<String, String> params) {}
39 39  {{/code}}
40 40  
41 -
42 42  
43 43  === Parameter saveResult2 ===
44 44  
31 +(% class="wrapped" %)
45 45  |(((
46 46  uniqueId
47 47  )))|(((
48 -Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
35 +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
40 +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,10 +58,9 @@
58 58  Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
59 59  )))
60 60  
61 -
62 -
63 63  === returnValue saveResult2 ===
64 64  
50 +(% class="wrapped" %)
65 65  |(((
66 66  boolean
67 67  )))|(((
... ... @@ -70,8 +70,6 @@
70 70  
71 71  == Ergebnisse speichern (Legacy) ==
72 72  
73 -
74 -
75 75  {{code title="Ergebnisse speichern (Legacy)"}}
76 76  @RestMethod(name = "saveResult")
77 77  public Boolean saveResult(
... ... @@ -79,23 +79,24 @@
79 79  @RestParam(name = "resultFile") final byte[] resultFile) {}
80 80  {{/code}}
81 81  
82 -
83 83  
84 84  === Parameter saveResult2 ===
85 85  
69 +(% class="wrapped" %)
86 86  |(((
87 87  uniqueId
88 88  )))|(((
89 -Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
73 +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
78 +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 ===
98 98  
83 +(% class="wrapped" %)
99 99  |(((
100 100  boolean
101 101  )))|(((
... ... @@ -102,27 +102,22 @@
102 102  True bei Erfolg, sonst false
103 103  )))
104 104  
105 -
106 -
107 107  == Version der Schnittstelle abfragen ==
108 108  
109 -
110 -
111 111  {{code title="Version abfragen"}}
112 112  @RestMethod(name = "version")
113 113  public String version() {}
114 114  {{/code}}
115 115  
116 -
117 117  
118 118  === Parameter version ===
119 119  
120 120  keine
121 121  
122 -
123 123  
124 124  === returnValue saveResult2 ===
125 125  
105 +(% class="wrapped" %)
126 126  |(((
127 127  String
128 128  )))|(((
... ... @@ -129,8 +129,6 @@
129 129  Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
130 130  )))
131 131  
132 -
133 -
134 134  == Nutzer löschen ==
135 135  
136 136  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.
... ... @@ -149,6 +149,7 @@
149 149  
150 150  === Parameter deleteUser ===
151 151  
130 +(% class="wrapped" %)
152 152  |(((
153 153  login
154 154  )))|(((
... ... @@ -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
144 +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.
149 +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
... ... @@ -189,6 +189,7 @@
189 189  
190 190  Löschresultat-Informationen.
191 191  
171 +(% class="wrapped" %)
192 192  |(((
193 193  Key
194 194  )))|(((
... ... @@ -202,9 +202,7 @@
202 202  {{/layout-cell}}
203 203  {{/layout-section}}
204 204  {{/layout}}
205 -{{/sv-translation}}
206 206  
207 -{{sv-translation language="en"}}
208 208  {{layout}}
209 209  {{layout-section ac:type="two_right_sidebar"}}
210 210  {{layout-cell}}
... ... @@ -212,18 +212,173 @@
212 212  {{/layout-cell}}
213 213  
214 214  {{layout-cell}}
215 -{{scroll-ignore}}
216 -{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="On this page"}}
193 +{{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
194 +{{toc start="2"/}}
195 +{{/panel}}
196 +{{/layout-cell}}
197 +{{/layout-section}}
217 217  
199 +{{layout-section ac:type="single"}}
200 +{{layout-cell}}
201 +== Save results ==
218 218  
219 -{{toc/}}
203 +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:
220 220  
221 -**related pages**
205 +{{code title="Save results"}}
206 +@RestMethod(name = "saveResult2")
207 +public Boolean saveResult(
208 +@RestParam(name = "uniqueId") final String uniqueId,
209 +@RestParam(name = "resultFile") final byte[] resultFile,
210 +@RestParam(name = "params") final Map<String, String> params) {}
211 +{{/code}}
222 222  
223 -* pages
224 -{{/panel}}
225 -{{/scroll-ignore}}
213 +
214 +=== Parameter saveResult2 ===
215 +
216 +|(((
217 +uniqueId
218 +)))|(((
219 +Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
220 +)))
221 +|(((
222 +resultFile
223 +)))|(((
224 +Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
225 +)))
226 +|(((
227 +params
228 +)))|(((
229 +Generic parameters. These are currently only stored without further processing.
230 +)))
231 +
232 +=== returnValue saveResult2 ===
233 +
234 +|(((
235 +boolean
236 +)))|(((
237 +True if successful, otherwise false
238 +)))
239 +
240 +== Save results (legacy) ==
241 +
242 +{{code title="Save results (legacy)"}}
243 +@RestMethod(name = "saveResult")
244 +public Boolean saveResult(
245 +@RestParam(name = "uniqueId") final String uniqueId,
246 +@RestParam(name = "resultFile") final byte[] resultFile) {}
247 +{{/code}}
248 +
249 +
250 +=== Parameter saveResult2 ===
251 +
252 +|(((
253 +uniqueId
254 +)))|(((
255 +Unique ID used by the ONYX WebPlayer and ONYX Editor when running the test.
256 +)))
257 +|(((
258 +resultFile
259 +)))|(((
260 +Result file as ZIP file (QTI-compliant result.xml, including any referenced files such as user uploads or user content if necessary)
261 +)))
262 +
263 +=== returnValue saveResult2 ===
264 +
265 +|(((
266 +boolean
267 +)))|(((
268 +True if successful, otherwise false
269 +)))
270 +
271 +== Query interface version ==
272 +
273 +{{code title="Query version"}}
274 +@RestMethod(name = "version")
275 +public String version() {}
276 +{{/code}}
277 +
278 +
279 +=== Parameter version ===
280 +
281 +None
282 +
283 +
284 +=== returnValue saveResult2 ===
285 +
286 +|(((
287 +String
288 +)))|(((
289 +REST interface version, currently always "1.0 (ONYX Editor version)"
290 +)))
291 +
292 +== Delete user ==
293 +
294 +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.
295 +
296 +{{code title="Delete user"}}
297 +@RestMethod
298 +public Map<String, String> deleteUser(
299 + @RestParam(name = "login") final String login,
300 + @RestParam(name = "password") final String password,
301 + @RestParam(name = "repo") final String repo,
302 + @RestParam(name = "property") final String property,
303 + @RestParam(name = "values") final ArrayList<String> values,
304 + @RestParam(name = "reason") final String reason,
305 + @RestParam(name = "params") final Map<String, String> params) {}
306 +{{/code}}
307 +
308 +=== Parameter deleteUser ===
309 +
310 +|(((
311 +login
312 +)))|(((
313 +User name of an ONYX Editor admin user who has the right to delete other users.
314 +)))
315 +|(((
316 +password
317 +)))|(((
318 +Password of this ONYX Editor admin user.
319 +)))
320 +|(((
321 +repo
322 +)))|(((
323 +ID of the LMS repository as it is already configured in the LMS and used for communication with the ONYX Editor.
324 +)))
325 +|(((
326 +property
327 +)))|(((
328 +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.
329 +)))
330 +|(((
331 +values
332 +)))|(((
333 +List of values to filter by, for example, list of user names.
334 +)))
335 +|(((
336 +reason
337 +)))|(((
338 +Reason for deletion. Will be included in the deletion log.
339 +)))
340 +|(((
341 +params
342 +)))|(((
343 +Currently not used
344 +)))
345 +
346 +=== returnValue deleteUser ===
347 +
348 +Deletion result information.
349 +
350 +|(((
351 +Key
352 +)))|(((
353 +The values as specified in the _values_ parameter
354 +)))
355 +|(((
356 +Value
357 +)))|(((
358 +Deletion result (e. g _NOT FOUND_, _ERROR:xyz_, ...)
359 +)))
226 226  {{/layout-cell}}
227 227  {{/layout-section}}
228 228  {{/layout}}
229 -{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -234979411
1 +226230567
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/226230567/Schnittstelle ONYX Editor