Bildungsinventarexport per Berichts-API
Mit dem Bericht Dynamische Bildungsinventareinträge können Sie Bildunginventardaten per REST-API aufrufen und auswerten. Wie Sie dafür vorgehen, erfahren Sie hier. Für die Erstellung eines neuen Requests können Sie kostenfreie API-Entwicklungstools verwenden, wie z.B. Postman.
1
Erstellen Sie mit Ihrem API-Autoren einen Berichtsfavoriten für den Bericht Dynamische Bildungsinventardaten. Begrenzen Sie dabei den Zeitraum in den Filteroptionen, da eine zu große Datenmenge zu Verarbeitungsproblemen führen kann. Setzen Sie das Start- und das Enddatum entsprechend weit in die Vergangenheit bzw. Zukunft, da eine automatische Anpassung durch die Schnittstelle nicht erfolgt.
2
Für den automatisierten Abruf der Bildungsinventardaten per API ist die ID des Berichtsfavoriten erforderlich. Diese finden Sie nach dem Aufruf des Berichtsfavoriten in der URL. Kopieren Sie die ID in die Zwischenablage.
3
Konfigurieren Sie den Request in einem API-Entwicklungstool. Auf den Screenshot sehen Sie als Beispiel das Tool Postman.
Wählen Sie die GET-Methode aus und ergänzen Sie hinter der URL Ihrer Lernwelt die Version und den Endpunkt:
/v1/report/favouriteReportId
4
Legen Sie im Accept-Header fest, in welchem Format die Antwort des Servers zurückgegeben werden soll, z.B. JSON. Dieses Format eignet sich besonders zum Testen, da es weit verbreitet und gut strukturiert ist, wodurch es sich einfach analysieren und weiterverarbeiten lässt.
5
Fügen Sie anstelle der favoriteReportId nun die ID des Berichtsfavoriten ein. Speichern Sie anschließend Ihre Konfiguration und klicken Sie auf den Button Send.
6
Anschließend erhalten Sie als Ergebnis die Bildungsinventardaten der Mitarbeiter entsprechend der im Berichtsfavoriten eingestellten Filterung.
So können Sie überprüfen, ob die API korrekt konfiguriert ist und Sie alle für Sie notwendigen Informationen erhalten, bevor Sie die API in Zusammenarbeit mit Ihrer IT in den Live-Betrieb nehmen.
Voraussetzungen
- Wir empfehlen, einen API-Autoren-Account zu erstellen, der nur für die Schnittstelle und nicht für andere Zwecke verwendet wird.
- Diesem API-Autoren-Account sollten Sie eine Berechtigungsgruppe zuweisen, die es dem API-Autor ermöglicht, auf den entsprechenden Bericht sowie auf die entsprechenden Mandanten zuzugreifen.
- Damit Sie die Bildungsinventareinträge aus Avendoo korrekt in Ihrem kundenspezifischen System zuordnen können, müssen Sie sicherstellen, dass es auf beiden Seiten eine eindeutige Kennung gibt, z.B. Benutzername, Personalnummer, externe Referenz.