Änderungen von Dokument 06 Schnittstelle ONYX Editor

Zusammenfassung

• Seiteneigenschaften (3 geändert, 0 hinzugefügt, 0 gelöscht)
• Objekte (1 geändert, 0 hinzugefügt, 0 gelöscht)
  • Confluence.Code.ConfluencePageClass[0]

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,8 +1,4 @@
1	1	{{layout}}
2		-{{layout-section ac:type="single"}}
3		-{{layout-cell}}{{/layout-cell}}
4		-{{/layout-section}}
5		-
6	6	{{layout-section ac:type="two_right_sidebar"}}
7	7	{{layout-cell}}
8	8
...	...	@@ -9,17 +9,9 @@
9	9	{{/layout-cell}}
10	10
11	11	{{layout-cell}}
12		-{{scroll-ignore}}
13	13	{{panel title="Inhalt"}}
14		-
15		-
16		-{{toc/}}
	9	+{{toc depth="3" start="2"/}}
17	17	{{/panel}}
18		-{{/scroll-ignore}}
19		-
20		-
21		-
22		-
23	23	{{/layout-cell}}
24	24	{{/layout-section}}
25	25
...	...	@@ -37,19 +37,19 @@
37	37	@RestParam(name = "params") final Map<String, String> params) {}
38	38	{{/code}}
39	39
40		-
41	41
42	42	=== Parameter saveResult2 ===
43	43
	31	+(% class="wrapped" %)
44	44	|(((
45	45	uniqueId
46	46	)))|(((
47		-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.
48	48	)))
49	49	|(((
50	50	resultFile
51	51	)))|(((
52		-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)
53	53	)))
54	54	|(((
55	55	params
...	...	@@ -57,10 +57,9 @@
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
	50	+(% class="wrapped" %)
64	64	|(((
65	65	boolean
66	66	)))|(((
...	...	@@ -69,8 +69,6 @@
69	69
70	70	== Ergebnisse speichern (Legacy) ==
71	71
72		-
73		-
74	74	{{code title="Ergebnisse speichern (Legacy)"}}
75	75	@RestMethod(name = "saveResult")
76	76	public Boolean saveResult(
...	...	@@ -78,23 +78,24 @@
78	78	@RestParam(name = "resultFile") final byte[] resultFile) {}
79	79	{{/code}}
80	80
81		-
82	82
83	83	=== Parameter saveResult2 ===
84	84
	69	+(% class="wrapped" %)
85	85	|(((
86	86	uniqueId
87	87	)))|(((
88		-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.
89	89	)))
90	90	|(((
91	91	resultFile
92	92	)))|(((
93		-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)
94	94	)))
95	95
96	96	=== returnValue saveResult2 ===
97	97
	83	+(% class="wrapped" %)
98	98	|(((
99	99	boolean
100	100	)))|(((
...	...	@@ -101,27 +101,22 @@
101	101	True bei Erfolg, sonst false
102	102	)))
103	103
104		-
105		-
106	106	== Version der Schnittstelle abfragen ==
107	107
108		-
109		-
110	110	{{code title="Version abfragen"}}
111	111	@RestMethod(name = "version")
112	112	public String version() {}
113	113	{{/code}}
114	114
115		-
116	116
117	117	=== Parameter version ===
118	118
119	119	keine
120	120
121		-
122	122
123	123	=== returnValue saveResult2 ===
124	124
	105	+(% class="wrapped" %)
125	125	|(((
126	126	String
127	127	)))|(((
...	...	@@ -128,8 +128,6 @@
128	128	Version der REST-Schnittstelle, aktuell immer "1.0 (ONYX-Editor-Version)"
129	129	)))
130	130
131		-
132		-
133	133	== Nutzer löschen ==
134	134
135	135	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.
...	...	@@ -148,6 +148,7 @@
148	148
149	149	=== Parameter deleteUser ===
150	150
	130	+(% class="wrapped" %)
151	151	|(((
152	152	login
153	153	)))|(((
...	...	@@ -161,12 +161,12 @@
161	161	|(((
162	162	repo
163	163	)))|(((
164		-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.
165	165	)))
166	166	|(((
167	167	property
168	168	)))|(((
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.
	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.
170	170	)))
171	171	|(((
172	172	values
...	...	@@ -188,6 +188,7 @@
188	188
189	189	Löschresultat-Informationen.
190	190
	171	+(% class="wrapped" %)
191	191	|(((
192	192	Key
193	193	)))|(((

Confluence.Code.ConfluencePageClass[0]

id

...	...	@@ -1,1 +1,1 @@
1		-226231253
	1	+226230567

url

...	...	@@ -1,1 +1,1 @@
1		-https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226231253/Schnittstelle ONYX Editor
	1	+https://www.bps-system.de/help/display/SOV/wiki/spaces/ONYX/pages/226230567/Schnittstelle ONYX Editor