- 11 Apr 2023
- 1 Minute zum Lesen
API-Dokumentation anzeigen
- Aktualisiert am 11 Apr 2023
- 1 Minute zum Lesen
Wenn Sie mit der externen API in Totara arbeiten, sollten Sie ein API-Referenzhandbuch sehen, das alle in der API verfügbaren Dienste und deren Verwendung beschreibt. Totara verfügt über eine integrierte Referenzdokumentation, die aus dem GraphQL-Schema generiert wurde. Diese Dokumentation spiegelt die API-Funktionen wider, die für die spezifische Version von Totara verfügbar sind, auf der die Website läuft, und umfasst Dienste, die durch Codeanpassungen von Drittanbietern hinzugefügt oder geändert werden.
So zeigen Sie die Dokumentation an:
- Navigieren Sie zum Schnellzugriffsmenü > API>>-Dokumentation Entwicklung.
- Verwenden Sie das Inhaltsverzeichnis in der linken Spalte, um zu einem bestimmten Abschnitt zu springen.
- Klicken Sie auf Zurück zur API , um zur Liste der API-Clients zurückzukehren.
Auf dieser Seite sehen Sie die folgenden Informationen zur API:
- Endpunkt-Details
- Authentifizierung
- Format anfordern
- Link zum API-Schema
- Verfügbare Abfragen und Mutationen
- Verfügbare Typen
Die Dokumentationsseite enthält Beispiele für das Format sowohl der spezifischen Anfrage als auch der Antwort, die von der API zurückgegeben wird.
© Copyright 2024 Totara Learning Solutions. All rights reserved.