Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 24.11.2025

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 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,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,23 +200,17 @@
200 200  {{/layout-cell}}
201 201  {{/layout-section}}
202 202  {{/layout}}
203 -{{/sv-translation}}
204 204  
205 -{{sv-translation language="en"}}
206 206  {{layout}}
207 207  {{layout-section ac:type="two_right_sidebar"}}
208 208  {{layout-cell}}
209 -\\
189 +
210 210  {{/layout-cell}}
211 211  
212 212  {{layout-cell}}
213 -{{scroll-ignore}}
214 214  {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
215 -
216 -
217 -{{toc/}}
194 +{{toc start="2"/}}
218 218  {{/panel}}
219 -{{/scroll-ignore}}
220 220  {{/layout-cell}}
221 221  {{/layout-section}}
222 222  
... ... @@ -234,7 +234,6 @@
234 234  @RestParam(name = "params") final Map<String, String> params) {}
235 235  {{/code}}
236 236  
237 -\\
238 238  
239 239  === Parameter saveResult2 ===
240 240  
... ... @@ -254,8 +254,6 @@
254 254  Generic parameters. These are currently only stored without further processing.
255 255  )))
256 256  
257 -\\
258 -
259 259  === returnValue saveResult2 ===
260 260  
261 261  |(((
... ... @@ -266,8 +266,6 @@
266 266  
267 267  == Save results (legacy) ==
268 268  
269 -\\
270 -
271 271  {{code title="Save results (legacy)"}}
272 272  @RestMethod(name = "saveResult")
273 273  public Boolean saveResult(
... ... @@ -275,7 +275,6 @@
275 275  @RestParam(name = "resultFile") final byte[] resultFile) {}
276 276  {{/code}}
277 277  
278 -\\
279 279  
280 280  === Parameter saveResult2 ===
281 281  
... ... @@ -298,24 +298,18 @@
298 298  True if successful, otherwise false
299 299  )))
300 300  
301 -\\
302 -
303 303  == Query interface version ==
304 304  
305 -\\
306 -
307 307  {{code title="Query version"}}
308 308  @RestMethod(name = "version")
309 309  public String version() {}
310 310  {{/code}}
311 311  
312 -\\
313 313  
314 314  === Parameter version ===
315 315  
316 316  None
317 317  
318 -\\
319 319  
320 320  === returnValue saveResult2 ===
321 321  
... ... @@ -325,8 +325,6 @@
325 325  REST interface version, currently always "1.0 (ONYX Editor version)"
326 326  )))
327 327  
328 -\\
329 -
330 330  == Delete user ==
331 331  
332 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.
... ... @@ -398,4 +398,3 @@
398 398  {{/layout-cell}}
399 399  {{/layout-section}}
400 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