Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zuletzt geändert von Carina Enke am 13.02.2024

Von Version 96.1
bearbeitet von Carina Enke
am 13.02.2024
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 86.1
bearbeitet von Carina Enke
am 08.05.2019
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich ONYXintern und Version 8.7.

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,4 +1,8 @@
1 1  {{layout}}
2 +{{layout-section ac:type="single"}}
3 +{{layout-cell}}{{/layout-cell}}
4 +{{/layout-section}}
5 +
2 2  {{layout-section ac:type="two_right_sidebar"}}
3 3  {{layout-cell}}
4 4  
... ... @@ -5,9 +5,17 @@
5 5  {{/layout-cell}}
6 6  
7 7  {{layout-cell}}
12 +{{scroll-ignore}}
8 8  {{panel title="Inhalt"}}
9 -{{toc depth="3" start="2"/}}
14 +
15 +
16 +{{toc/}}
10 10  {{/panel}}
18 +{{/scroll-ignore}}
19 +
20 +
21 +
22 +
11 11  {{/layout-cell}}
12 12  {{/layout-section}}
13 13  
... ... @@ -25,19 +25,19 @@
25 25  @RestParam(name = "params") final Map<String, String> params) {}
26 26  {{/code}}
27 27  
40 +
28 28  
29 29  === Parameter saveResult2 ===
30 30  
31 -(% class="wrapped" %)
32 32  |(((
33 33  uniqueId
34 34  )))|(((
35 -Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben.
47 +Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
36 36  )))
37 37  |(((
38 38  resultFile
39 39  )))|(((
40 -Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents)
52 +Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
41 41  )))
42 42  |(((
43 43  params
... ... @@ -45,9 +45,10 @@
45 45  Generische Parameter. Diese werden aktuell ohne weitere Verarbeitung einfach nur gespeichert.
46 46  )))
47 47  
60 +
61 +
48 48  === returnValue saveResult2 ===
49 49  
50 -(% class="wrapped" %)
51 51  |(((
52 52  boolean
53 53  )))|(((
... ... @@ -56,6 +56,8 @@
56 56  
57 57  == Ergebnisse speichern (Legacy) ==
58 58  
72 +
73 +
59 59  {{code title="Ergebnisse speichern (Legacy)"}}
60 60  @RestMethod(name = "saveResult")
61 61  public Boolean saveResult(
... ... @@ -63,24 +63,23 @@
63 63  @RestParam(name = "resultFile") final byte[] resultFile) {}
64 64  {{/code}}
65 65  
81 +
66 66  
67 67  === Parameter saveResult2 ===
68 68  
69 -(% class="wrapped" %)
70 70  |(((
71 71  uniqueId
72 72  )))|(((
73 -Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben.
88 +Eindeutige ID, die ONYX WebPlayer und ONYX Editor bei der Ausführung des Tests vereinbart haben
74 74  )))
75 75  |(((
76 76  resultFile
77 77  )))|(((
78 -Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents)
93 +Ergebnis-Datei als ZIP-File (QTI-konformes result.xml, ggf. inkl. darin referenzierter Dateien wie User-Uploads oder User-Contents
79 79  )))
80 80  
81 81  === returnValue saveResult2 ===
82 82  
83 -(% class="wrapped" %)
84 84  |(((
85 85  boolean
86 86  )))|(((
... ... @@ -87,22 +87,27 @@
87 87  True bei Erfolg, sonst false
88 88  )))
89 89  
104 +
105 +
90 90  == Version der Schnittstelle abfragen ==
91 91  
108 +
109 +
92 92  {{code title="Version abfragen"}}
93 93  @RestMethod(name = "version")
94 94  public String version() {}
95 95  {{/code}}
96 96  
115 +
97 97  
98 98  === Parameter version ===
99 99  
100 100  keine
101 101  
121 +
102 102  
103 103  === returnValue saveResult2 ===
104 104  
105 -(% class="wrapped" %)
106 106  |(((
107 107  String
108 108  )))|(((
... ... @@ -109,6 +109,8 @@
109 109  Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
110 110  )))
111 111  
131 +
132 +
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.
... ... @@ -127,7 +127,6 @@
127 127  
128 128  === Parameter deleteUser ===
129 129  
130 -(% class="wrapped" %)
131 131  |(((
132 132  login
133 133  )))|(((
... ... @@ -141,12 +141,12 @@
141 141  |(((
142 142  repo
143 143  )))|(((
144 -ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird.
164 +ID des LMS-Repositories, so wie diese im LMS bereits konfiguriert ist und zur Kommunikation mit dem ONYX Editor verwendet wird
145 145  )))
146 146  |(((
147 147  property
148 148  )))|(((
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.
169 +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.
150 150  )))
151 151  |(((
152 152  values
... ... @@ -168,7 +168,6 @@
168 168  
169 169  Löschresultat-Informationen.
170 170  
171 -(% class="wrapped" %)
172 172  |(((
173 173  Key
174 174  )))|(((
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -226230567
1 +226230829
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/226230829/Schnittstelle ONYX Editor