Skip to Content

Changes for page REST-API Überblick

Last modified by Carina Enke on 14.10.2025
From version 115.1
edited by Carina Enke
on 14.10.2025
Change comment: There is no comment for this version
To version 107.1
edited by Carina Enke
on 22.03.2024
Change comment: Zurück zur Version 105.1

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -REST API Überblick
1 +Dokumentation REST API
Content
... ... @@ -1,12 +1,45 @@
1 +{{layout}}
2 +{{layout-section ac:type="two_right_sidebar"}}
3 +{{layout-cell}}
1 1  == REST-Schnittstelle der Lernplattform ==
2 2  
3 -Die Lernplattform stellt eine REST-API zur Verfügung, über die Daten per HTTP(S) abgerufen und verwaltet werden können. Die API ermöglicht es registrierten Nutzern, Funktionen der Plattform programmgesteuert zu nutzen – unabhängig von der Benutzeroberfläche. So lassen sich beispielsweise Abfragen durchführen oder wiederkehrende Aufgaben automatisieren. Welche Endpunkte und Aktionen verfügbar sind, richtet sich nach den individuellen Berechtigungen des jeweiligen Nutzers und entspricht den Funktionen, die auch in der Weboberfläche zur Verfügung stehen.
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  
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.
10 +
11 +
12 +{{/layout-cell}}
13 +
14 +{{layout-cell}}
15 +{{panel title="Inhalt"}}
16 +{{toc start="2"/}}
17 +{{/panel}}
18 +{{/layout-cell}}
19 +{{/layout-section}}
20 +
21 +{{layout-section ac:type="single"}}
22 +{{layout-cell}}
6 6  == Dokumentation zur Schnittstelle ==
7 7  
8 8  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.
9 9  
27 +
28 +=== Download der Dokumentation ===
29 +
10 10  {{info}}
11 -Der Dokumentationsbereich ist passwortgeschützt. Bitte senden Sie eine E-Mail zur Passwortanfrage [[support@bps-system.de>>mailto:support@bps-system.de||shape="rect"]].
31 +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"]].
12 12  {{/info}}
33 +
34 +
35 +(% style="margin-left: 40.0px;" %)
36 +Aktuelle Version: REST API-v78-20230906
37 +
38 +(% style="margin-left: 40.0px;" %)
39 +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"]]
40 +
41 +
42 +
43 +{{/layout-cell}}
44 +{{/layout-section}}
45 +{{/layout}}