Zum Inhalt springen

Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 90.1
bearbeitet von Carina Enke
am 19.12.2023
Änderungskommentar: Es gibt keinen Kommentar für diese Version
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
Inhalt
... ... @@ -1,24 +2,13 @@
1 -
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,7 +36,6 @@
36 36  @RestParam(name = "params") final Map<String, String> params) {}
37 37  {{/code}}
38 38  
39 -\\
40 40  
41 41  === Parameter saveResult2 ===
42 42  
... ... @@ -57,8 +57,6 @@
57 57  Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
58 58  )))
59 59  
60 -\\
61 -
62 62  === returnValue saveResult2 ===
63 63  
64 64  (% class="wrapped" %)
... ... @@ -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,7 +79,6 @@
79 79  @RestParam(name = "resultFile") final byte[] resultFile) {}
80 80  {{/code}}
81 81  
82 -\\
83 83  
84 84  === Parameter saveResult2 ===
85 85  
... ... @@ -104,24 +104,18 @@
104 104  True bei Erfolg, sonst false
105 105  )))
106 106  
107 -\\
108 -
109 109  == Version der Schnittstelle abfragen ==
110 110  
111 -\\
112 -
113 113  {{code title="Version abfragen"}}
114 114  @RestMethod(name = "version")
115 115  public String version() {}
116 116  {{/code}}
117 117  
118 -\\
119 119  
120 120  === Parameter version ===
121 121  
122 122  keine
123 123  
124 -\\
125 125  
126 126  === returnValue saveResult2 ===
127 127  
... ... @@ -132,8 +132,6 @@
132 132  Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
133 133  )))
134 134  
135 -\\
136 -
137 137  == Nutzer löschen ==
138 138  
139 139  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.
... ... @@ -207,23 +207,17 @@
207 207  {{/layout-cell}}
208 208  {{/layout-section}}
209 209  {{/layout}}
210 -{{/sv-translation}}
211 211  
212 -{{sv-translation language="en"}}
213 213  {{layout}}
214 214  {{layout-section ac:type="two_right_sidebar"}}
215 215  {{layout-cell}}
216 -\\
189 +
217 217  {{/layout-cell}}
218 218  
219 219  {{layout-cell}}
220 -{{scroll-ignore}}
221 221  {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
222 -
223 -
224 -{{toc/}}
194 +{{toc start="2"/}}
225 225  {{/panel}}
226 -{{/scroll-ignore}}
227 227  {{/layout-cell}}
228 228  {{/layout-section}}
229 229  
... ... @@ -241,7 +241,6 @@
241 241  @RestParam(name = "params") final Map<String, String> params) {}
242 242  {{/code}}
243 243  
244 -\\
245 245  
246 246  === Parameter saveResult2 ===
247 247  
... ... @@ -261,8 +261,6 @@
261 261  Generic parameters. These are currently only stored without further processing.
262 262  )))
263 263  
264 -\\
265 -
266 266  === returnValue saveResult2 ===
267 267  
268 268  |(((
... ... @@ -273,8 +273,6 @@
273 273  
274 274  == Save results (legacy) ==
275 275  
276 -\\
277 -
278 278  {{code title="Save results (legacy)"}}
279 279  @RestMethod(name = "saveResult")
280 280  public Boolean saveResult(
... ... @@ -282,7 +282,6 @@
282 282  @RestParam(name = "resultFile") final byte[] resultFile) {}
283 283  {{/code}}
284 284  
285 -\\
286 286  
287 287  === Parameter saveResult2 ===
288 288  
... ... @@ -305,24 +305,18 @@
305 305  True if successful, otherwise false
306 306  )))
307 307  
308 -\\
309 -
310 310  == Query interface version ==
311 311  
312 -\\
313 -
314 314  {{code title="Query version"}}
315 315  @RestMethod(name = "version")
316 316  public String version() {}
317 317  {{/code}}
318 318  
319 -\\
320 320  
321 321  === Parameter version ===
322 322  
323 323  None
324 324  
325 -\\
326 326  
327 327  === returnValue saveResult2 ===
328 328  
... ... @@ -332,8 +332,6 @@
332 332  REST interface version, currently always "1.0 (ONYX Editor version)"
333 333  )))
334 334  
335 -\\
336 -
337 337  == Delete user ==
338 338  
339 339  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.
... ... @@ -405,4 +405,3 @@
405 405  {{/layout-cell}}
406 406  {{/layout-section}}
407 407  {{/layout}}
408 -{{/sv-translation}}