Zum Inhalt springen

Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 13.02.2024
Von Version 95.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 53.1
bearbeitet von Carina Enke
am 26.08.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 9.8.

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -05 Schnittstelle ONYX Editor
1 +Schnittstelle ONYX Editor
Übergeordnete Seite
... ... @@ -1,1 +1,0 @@
1 -ONYX.Systeminformationen.WebHome
Inhalt
... ... @@ -1,13 +1,104 @@
1 +{{sv-translation language="de"}}
1 1  {{layout}}
3 +{{layout-section ac:type="single"}}
4 +{{layout-cell}}
5 +\\
6 +
7 +{{details}}
8 +(% class="wrapped" %)
9 +|=(((
10 +Verantwortlicher
11 +)))|(((
12 +\\
13 +)))
14 +|=(% colspan="1" %)(% colspan="1" %)
15 +(((
16 +Status
17 +)))|(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)(% class="highlight-yellow" colspan="1" data-highlight-colour="yellow" %)
18 +(((
19 +(% class="content-wrapper" %)
20 +(((
21 +{{sv-metadata type="workflow-status"/}}
22 +
23 +{{status colour="Green" title="Fertig"/}}
24 +)))
25 +)))
26 +|=(% colspan="1" %)(% colspan="1" %)
27 +(((
28 +Varianten
29 +)))|(% colspan="1" %)(% colspan="1" %)
30 +(((
31 +(% class="content-wrapper" %)
32 +(((
33 +{{sv-metadata type="variants"/}}
34 +)))
35 +)))
36 +|=(% colspan="1" %)(% colspan="1" %)
37 +(((
38 +Attribute
39 +)))|(% colspan="1" %)(% colspan="1" %)
40 +(((
41 +(% class="content-wrapper" %)
42 +(((
43 +{{sv-metadata type="attributes"/}}
44 +)))
45 +)))
46 +|=(% colspan="1" %)(% colspan="1" %)
47 +(((
48 +Pagekey
49 +)))|(% colspan="1" %)(% colspan="1" %)
50 +(((
51 +(% class="content-wrapper" %)
52 +(((
53 +{{sv-metadata type="pagekey"/}}
54 +)))
55 +)))
56 +|=(% colspan="1" %)(% colspan="1" %)
57 +(((
58 +Übersetzung
59 +)))|(% colspan="1" %)(% colspan="1" %)
60 +(((
61 +(% class="content-wrapper" %)
62 +(((
63 +Interface ONYX Editor 
64 +
65 +{{status colour="Green" title="fertig"/}}
66 +)))
67 +)))
68 +|=(% colspan="1" %)(% colspan="1" %)
69 +(((
70 +TODOs
71 +)))|(% colspan="1" %)(% colspan="1" %)
72 +(((
73 +(% class="content-wrapper" %)
74 +(((
75 +Stand der Infos auf Ticket ONYX-4213 vom Aug 2018
76 +
77 +(% class="task-list" %)
78 +(((
79 +{{task reference="/Tasks/Task_1" status="Done"}}
80 +carina {{mention reference="XWiki.0a49950f5c0f19a8015c101b60e10001" style="FULL_NAME" anchor="XWiki-0a49950f5c0f19a8015c101b60e10001-iFutI"/}}Neue Seite bitte übersetzen
81 +{{/task}}
82 +)))
83 +)))
84 +)))
85 +{{/details}}
86 +{{/layout-cell}}
87 +{{/layout-section}}
88 +
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
4 -
91 +\\
5 5  {{/layout-cell}}
6 6  
7 7  {{layout-cell}}
95 +{{scroll-ignore}}
8 8  {{panel title="Inhalt"}}
9 -{{toc depth="3" start="2"/}}
97 +
98 +
99 +{{toc/}}
10 10  {{/panel}}
101 +{{/scroll-ignore}}
11 11  {{/layout-cell}}
12 12  {{/layout-section}}
13 13  
... ... @@ -25,6 +25,7 @@
25 25  @RestParam(name = "params") final Map<String, String> params) {}
26 26  {{/code}}
27 27  
119 +\\
28 28  
29 29  === Parameter saveResult2 ===
30 30  
... ... @@ -45,6 +45,8 @@
45 45  Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
46 46  )))
47 47  
140 +\\
141 +
48 48  === returnValue saveResult2 ===
49 49  
50 50  (% class="wrapped" %)
... ... @@ -56,6 +56,8 @@
56 56  
57 57  == Ergebnisse speichern (Legacy) ==
58 58  
153 +\\
154 +
59 59  {{code title="Ergebnisse speichern (Legacy)"}}
60 60  @RestMethod(name = "saveResult")
61 61  public Boolean saveResult(
... ... @@ -63,6 +63,7 @@
63 63  @RestParam(name = "resultFile") final byte[] resultFile) {}
64 64  {{/code}}
65 65  
162 +\\
66 66  
67 67  === Parameter saveResult2 ===
68 68  
... ... @@ -87,18 +87,24 @@
87 87  True bei Erfolg, sonst false
88 88  )))
89 89  
187 +\\
188 +
90 90  == Version der Schnittstelle abfragen ==
91 91  
191 +\\
192 +
92 92  {{code title="Version abfragen"}}
93 93  @RestMethod(name = "version")
94 94  public String version() {}
95 95  {{/code}}
96 96  
198 +\\
97 97  
98 98  === Parameter version ===
99 99  
100 100  keine
101 101  
204 +\\
102 102  
103 103  === returnValue saveResult2 ===
104 104  
... ... @@ -109,6 +109,8 @@
109 109  Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
110 110  )))
111 111  
215 +\\
216 +
112 112  == Nutzer löschen ==
113 113  
114 114  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.
... ... @@ -182,17 +182,23 @@
182 182  {{/layout-cell}}
183 183  {{/layout-section}}
184 184  {{/layout}}
290 +{{/sv-translation}}
185 185  
292 +{{sv-translation language="en"}}
186 186  {{layout}}
187 187  {{layout-section ac:type="two_right_sidebar"}}
188 188  {{layout-cell}}
189 -
296 +\\
190 190  {{/layout-cell}}
191 191  
192 192  {{layout-cell}}
300 +{{scroll-ignore}}
193 193  {{panel borderColor="#ddd" bgColor="#f0f0f0" borderStyle="solid" title="Content"}}
194 -{{toc start="2"/}}
302 +
303 +
304 +{{toc/}}
195 195  {{/panel}}
306 +{{/scroll-ignore}}
196 196  {{/layout-cell}}
197 197  {{/layout-section}}
198 198  
... ... @@ -210,6 +210,7 @@
210 210  @RestParam(name = "params") final Map<String, String> params) {}
211 211  {{/code}}
212 212  
324 +\\
213 213  
214 214  === Parameter saveResult2 ===
215 215  
... ... @@ -229,6 +229,8 @@
229 229  Generic parameters. These are currently only stored without further processing.
230 230  )))
231 231  
344 +\\
345 +
232 232  === returnValue saveResult2 ===
233 233  
234 234  |(((
... ... @@ -239,6 +239,8 @@
239 239  
240 240  == Save results (legacy) ==
241 241  
356 +\\
357 +
242 242  {{code title="Save results (legacy)"}}
243 243  @RestMethod(name = "saveResult")
244 244  public Boolean saveResult(
... ... @@ -246,6 +246,7 @@
246 246  @RestParam(name = "resultFile") final byte[] resultFile) {}
247 247  {{/code}}
248 248  
365 +\\
249 249  
250 250  === Parameter saveResult2 ===
251 251  
... ... @@ -268,18 +268,24 @@
268 268  True if successful, otherwise false
269 269  )))
270 270  
388 +\\
389 +
271 271  == Query interface version ==
272 272  
392 +\\
393 +
273 273  {{code title="Query version"}}
274 274  @RestMethod(name = "version")
275 275  public String version() {}
276 276  {{/code}}
277 277  
399 +\\
278 278  
279 279  === Parameter version ===
280 280  
281 281  None
282 282  
405 +\\
283 283  
284 284  === returnValue saveResult2 ===
285 285  
... ... @@ -289,6 +289,8 @@
289 289  REST interface version, currently always "1.0 (ONYX Editor version)"
290 290  )))
291 291  
415 +\\
416 +
292 292  == Delete user ==
293 293  
294 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.
... ... @@ -360,3 +360,4 @@
360 360  {{/layout-cell}}
361 361  {{/layout-section}}
362 362  {{/layout}}
488 +{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -226230567
1 +666501616
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226230567/Schnittstelle ONYX Editor
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/666501616/Schnittstelle ONYX Editor