Changes for page REST API Überblick

Last modified by Carina Enke on 24.02.2025
From version 112.1
edited by Carina Enke
on 24.02.2025
Change comment: There is no comment for this version
To version 103.2
edited by Carina Enke
on 15.01.2024
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -REST API Überblick
1 +Dokumentation REST API
Parent
... ... @@ -1,1 +1,1 @@
1 -LMS.Benutzerhandbuch OPAL.Administration.Technische Dokumentationen.WebHome
1 +LMS.BenutzerhandbuchOPAL.Administration.Technische Dokumentationen.WebHome
Content
... ... @@ -1,17 +1,36 @@
1 +{{layout}}
2 +{{layout-section ac:type="two_right_sidebar"}}
3 +{{layout-cell}}
1 1  == REST-Schnittstelle der Lernplattform ==
2 2  
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.
6 +Die Lernplattform bietet Ihnen eine S(% style="color:#323232" %)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.
4 4  
5 5  
6 -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.
9 +(% style="color:#323232" %)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.
7 7  
11 +
8 8  
13 +{{/layout-cell}}
9 9  
15 +{{layout-cell}}
16 +{{panel title="Inhalt"}}
17 +{{toc maxLevel="2"/}}
18 +{{/panel}}
19 +{{/layout-cell}}
20 +{{/layout-section}}
21 +
22 +{{layout-section ac:type="single"}}
23 +{{layout-cell}}
10 10  == Dokumentation zur Schnittstelle ==
11 11  
12 12  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.
13 13  
28 +
29 +{{/layout-cell}}
30 +{{/layout-section}}
14 14  
32 +{{layout-section ac:type="single"}}
33 +{{layout-cell}}
15 15  === Download der Dokumentation ===
16 16  
17 17  {{info}}
... ... @@ -19,12 +19,15 @@
19 19  {{/info}}
20 20  
21 21  
41 +(% style="margin-left: 40.0px;" %)
42 +Aktuelle Version: REST API-v78-20230906
22 22  
23 -Aktuelle Version: REST API-v85-202400612.pdf
44 +(% style="margin-left: 40.0px;" %)
45 +Link zum Download: [[https:~~/~~/www.bps-system.de/share/download.jsp?id=1b1f9bad-91fa-418c-b4eb-6a258f3077d0>>url:https://www.bps-system.de/share/download.jsp?id=1b1f9bad-91fa-418c-b4eb-6a258f3077d0||shape="rect"]]
24 24  
25 25  
26 -Link zum Download: [[https:~~/~~/www.bps-system.de/share/download.jsp?id=e62c0b3e-1294-4010-848d-28e609ca97c7>>https://www.bps-system.de/share/download.jsp?id=e62c0b3e-1294-4010-848d-28e609ca97c7]]
27 27  
28 -
29 29  
30 -
50 +{{/layout-cell}}
51 +{{/layout-section}}
52 +{{/layout}}