Änderungen von Dokument REST-API Überblick
Zuletzt geändert von Carina Enke am 14.10.2025
Von Version 113.1
bearbeitet von Carina Enke
am 24.02.2025
am 24.02.2025
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Auf Version 116.1
bearbeitet von Carina Enke
am 14.10.2025
am 14.10.2025
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
-
Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
Details
- Seiteneigenschaften
-
- Titel
-
... ... @@ -1,1 +1,1 @@ 1 -REST API Überblick1 +REST-API Überblick - Inhalt
-
... ... @@ -1,6 +1,6 @@ 1 1 == REST-Schnittstelle der Lernplattform == 2 2 3 -Die Lernplattform bietet Ihnen eine Schnittstelle,dienach demREST-Schema(RepresentationalStateTransfer)Anfragen per HTTP(S) verarbeiten kann.ZielderSchnittstelleistdieBereitstellungund derAustausch vonDatenmit anderenSystemen.Unabhängig vom Logininder Benutzeroberfläche,könnenregistrierteNutzer mit Hilfeder SchnittstellekonkreteAnfragen und regelmäßige Aufgaben automatisieren.GrundsätzlichsinddabeinursolcheAktionenmöglich,die diesenNutzern auchin derOberflächeaufgrundIhrer individuellenBerechtigungenzur Verfügung stehen.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. 4 4 5 5 6 6 == Dokumentation zur Schnittstelle == ... ... @@ -7,10 +7,6 @@ 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 10 - 11 -=== Verfügbarkeit Dokumentation === 12 - 13 13 {{info}} 14 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"]]. 15 15 {{/info}} 16 -