Zum Inhalt springen

Änderungen von Dokument REST API Überblick

Zuletzt geändert von Carina Enke am 24.02.2025
Von Version 82.1
bearbeitet von Carina Enke
am 11.04.2023
Änderungskommentar: Mittels Scroll Versions veröffentlicht aus dem Bereich LMSintern und Version 13.12.
Auf Version 113.1
bearbeitet von Carina Enke
am 24.02.2025
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Titel
... ... @@ -1,1 +1,1 @@
1 -Dokumentation REST API
1 +REST API Überblick
Übergeordnete Seite
... ... @@ -1,0 +1,1 @@
1 +LMS.Benutzerhandbuch OPAL.Administration.Technische Dokumentationen.WebHome
Inhalt
... ... @@ -1,159 +95,16 @@
1 -{{sv-translation language="de"}}
2 -{{layout}}
3 -{{layout-section ac:type="single"}}
4 -{{layout-cell}}
5 -
6 -
7 -{{details}}
8 -(% class="wrapped" %)
9 -|=(((
10 -Verantwortlicher
11 -)))|(((
12 -Doku Link und Version in OLATCE-14765
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 -
22 -
23 -{{sv-metadata type="workflow-status"/}}
24 -
25 -{{status colour="Green" title="Fertig"/}}
26 -)))
27 -)))
28 -|=(% colspan="1" %)(% colspan="1" %)
29 -(((
30 -Varianten
31 -)))|(% colspan="1" %)(% colspan="1" %)
32 -(((
33 -(% class="content-wrapper" %)
34 -(((
35 -{{sv-metadata type="variants"/}}
36 -)))
37 -)))
38 -|=(% colspan="1" %)(% colspan="1" %)
39 -(((
40 -Attribute
41 -)))|(% colspan="1" %)(% colspan="1" %)
42 -(((
43 -(% class="content-wrapper" %)
44 -(((
45 -{{sv-metadata type="attributes"/}}
46 -)))
47 -)))
48 -|=(% colspan="1" %)(% colspan="1" %)
49 -(((
50 -Pagekey
51 -)))|(% colspan="1" %)(% colspan="1" %)
52 -(((
53 -(% class="content-wrapper" %)
54 -(((
55 -{{sv-metadata type="pagekey"/}}
56 -)))
57 -)))
58 -|=(% colspan="1" %)(% colspan="1" %)
59 -(((
60 -Übersetzung
61 -)))|(% colspan="1" %)(% colspan="1" %)
62 -(((
63 -(% class="content-wrapper" %)
64 -(((
65 -{{status colour="Red" title="Offen"/}}
66 -)))
67 -)))
68 -|=(% colspan="1" %)(% colspan="1" %)
69 -(((
70 -TODOs
71 -)))|(% colspan="1" %)(% colspan="1" %)
72 -(((
73 -(% class="task-list" %)
74 -(((
75 -{{task reference="/Tasks/Task_2" status="Done"}}
76 -carina: Seite initial erstellt, Seite wird öffentlich freigegeben (OLATCE-14765)
77 -
78 -{{/task}}
79 -
80 -{{task reference="/Tasks/Task_4" status="Done"}}
81 -carina: Neuer Link für Download
82 -{{/task}}
83 -
84 -{{task reference="/Tasks/Task_6" status="Done"}}
85 -carina: Permalink korrigiert und Mailadresse
86 -{{/task}}
87 -)))
88 -)))
89 -{{/details}}
90 -{{/layout-cell}}
91 -{{/layout-section}}
92 -
93 -{{layout-section ac:type="two_right_sidebar"}}
94 -{{layout-cell}}
95 95  == REST-Schnittstelle der Lernplattform ==
96 96  
97 -Die Lernplattform bietet Ihnen eine S(% style="color: rgb(50,50,50);" %)chnittstelle, die nach dem REST-Schema (Representational State Transfer) Anfragen per HTTP(S) verarbeiten kann. Ziel der Schnittstelle ist die Bereitstellung und der Austausch von Daten mit anderen Systemen.
3 +Die Lernplattform bietet Ihnen eine Schnittstelle, die nach dem REST-Schema (Representational State Transfer) Anfragen per HTTP(S) verarbeiten kann. Ziel der Schnittstelle ist die Bereitstellung und der Austausch von Daten mit anderen Systemen. Unabhängig vom Login in der Benutzeroberfläche, können registrierte Nutzer mit Hilfe der Schnittstelle konkrete Anfragen und regelmäßige Aufgaben automatisieren. Grundsätzlich sind dabei nur solche Aktionen möglich, die diesen Nutzern auch in der Oberfläche aufgrund Ihrer individuellen Berechtigungen zur Verfügung stehen.
98 98  
99 99  
100 -(% style="color: rgb(50,50,50);" %)Unabhängig vom Login in der Benutzeroberfläche können registrierte NutzerInnen mit Hilfe der Schnittstelle konkrete Anfragen und regelmäßige Aufgaben automatisieren. Grundsätzlich sind dabei nur solche Aktionen möglich, die Ihnen auch in der Oberfläche aufgrund Ihrer individuellen Berechtigungen zur Verfügung stehen.
101 -
102 -\\
103 -
104 -\\
105 -{{/layout-cell}}
106 -
107 -{{layout-cell}}
108 -{{scroll-ignore}}
109 -{{panel title="Inhalt"}}
110 -
111 -
112 -{{toc maxLevel="2"/}}
113 -{{/panel}}
114 -{{/scroll-ignore}}
115 -{{/layout-cell}}
116 -{{/layout-section}}
117 -
118 -{{layout-section ac:type="single"}}
119 -{{layout-cell}}
120 120  == Dokumentation zur Schnittstelle ==
121 121  
122 122  Zur Schnittstelle der Lernplattform ist eine Dokumentation verfügbar. Diese enthält je Abfrage die benötigte Syntax mit Beispiel, eine Beschreibung zum Funktionsinhalt sowie Angaben zu möglichen Parametern.
123 123  
124 -\\
125 -{{/layout-cell}}
126 -{{/layout-section}}
127 127  
128 -{{layout-section ac:type="single"}}
129 -{{layout-cell}}
130 -=== Download der Dokumentation ===
11 +=== Verfügbarkeit Dokumentation ===
131 131  
132 132  {{info}}
133 -Der Download der Dokumentation ist passwortgeschützt. Jede neue Version der Dokumentation erhält ein neues Passwort. Bitte senden Sie eine E-Mail zur Passwortanfrage [[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]].
14 +Der Dokumentationsbereich ist passwortgeschützt. Bitte senden Sie eine E-Mail zur Passwortanfrage [[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]].
134 134  {{/info}}
135 135  
136 -\\
137 -
138 -(% style="margin-left: 40.0px;" %)
139 -Aktuelle Version: (% style="color: rgb(23,25,28);" %)REST API-v51-20221213
140 -
141 -(% style="margin-left: 40.0px;" %)
142 -Link zum Download: [[https:~~/~~/www.bps-system.de/share/download.jsp?id=1a4ad05c-d506-4e5e-a311-42b9c3059392>>url:https://www.bps-system.de/share/download.jsp?id=1a4ad05c-d506-4e5e-a311-42b9c3059392||shape="rect"]]
143 -
144 -
145 -\\
146 -
147 -\\
148 -
149 -\\
150 -{{/layout-cell}}
151 -{{/layout-section}}
152 -{{/layout}}
153 -{{/sv-translation}}
154 -
155 -{{sv-translation language="en"}}
156 -
157 -
158 -{{includeplus spaceKey="LMS" scrollPageId="8AC9158F0169E71FC07AAFD92398FD30"/}}
159 -{{/sv-translation}}
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -675251328
1 +651198691
url
... ... @@ -1,1 +1,1 @@
1 -https://www.bps-system.de/help/display/SOV/wiki/spaces/LMS/pages/675251328/Dokumentation REST API
1 +https://www.bps-system.de/help/display/SOV/wiki/spaces/LMS/pages/651198691/Dokumentation REST API