Abschnitte der Learn365-API: Allgemeiner Überblick und Funktionen

Einführung

Die Learn365-API ermöglicht die Integration mit anderen Anwendungen, um organisatorische Prozesse zu optimieren und die Geschäftsleistung zu verbessern. Die Endpunkte der Learn365-API sind nach ihrem Zweck und ihrer Funktionalität in Abschnitte gruppiert.

In diesem Artikel vermitteln wir Informationen zum Inhalt der einzelnen Abschnitte.

 

TIPP

  • Die Abschnitte werden alphabetisch präsentiert. Die Beschreibung jedes Abschnitts basiert auf der allgemeinen Funktionalität der in dem Abschnitt enthaltenen APIs ohne Angabe von Abfrageoptionsparametern.

  • Um die Learn365-API nutzen zu können, müssen Sie sich zuerst anmelden.

WICHTIG

Wir haben neue Skills-Endpunkte implementiert, die zu gegebener Zeit die entsprechenden Competency-Endpunkte ersetzen werden. Sie können die bisherigen Competency-Endpunkte weiter nutzen, bis sie im Rahmen der Veröffentlichung von Learn365 v3.64 auslaufen. (Diese Veröffentlichung ist gegenwärtig für den 18. August 2025 geplant.)

Wir empfehlen Ihnen, bereits jetzt mit den Planungen für das Auslaufen der Competency-Endpunkte zu beginnen und zu den neuen Skills-Endpunkten zu migrieren. Hierdurch stellen Sie sicher, dass etwaige Probleme oder Fehler, auf die Sie stoßen, bis zum Zeitpunkt des Auslaufens der Endpunkte behoben werden können.

 

Apps

Der Abschnitt Apps enthält APIs, die nicht mehr als separate Anwendungen verwendet werden, sondern ein fester Bestandteil der Learn365-Lösung sind. Mithilfe dieser APIs können Sie eine Liste aller Anwendungen auf dem Mandanten zusammen mit den zugehörigen IDs abrufen.

 

 

Assessments

Der Abschnitt Assessments enthält APIs, mit denen Sie Bewertungsinformationen auf dem Mandanten abrufen können. Diese Informationen beinhalten die IDs der jeweiligen Bewertung und des Kurses, zu dem sie gehört, den Titel der Bewertung, eine Beschreibung, den Betreuer und die Einstellungen. Mithilfe der APIs in diesem Abschnitt können Sie Bewertungen erstellen, aktualisieren, löschen und genehmigen sowie eine Liste der Bewertungen auf dem Mandanten abrufen.

 

api_assessments.png

 

Assets

Der Abschnitt Assets enthält APIs, mit denen Sie Assets herunter- und hochladen können. Als „Assets“ werden jegliche Dokumente, Videos und Bilder bezeichnet, die Sie über den Rich-Text-Editor im Learn365 Admin Center einfügen können, zum Beispiel in Schulungs- oder Lernmodulbeschreibungen.

 

 

Weiterführender Artikel:

 

Assignments

Der Abschnitt Assignments enthält API-Endpunkte, die verwendet werden, um neue Zuweisungen zu erstellen, eine Liste von Zuweisungen auf dem Mandanten sowie deren IDs abzurufen und Zuweisungen als abgeschlossen zu kennzeichnen.

 


 

CertificateTemplates

Der Abschnitt CertificateTemplates enthält APIs, mit denen Sie eine Liste aller Zertifikatsvorlagen auf dem Mandanten abrufen sowie Zertifikatsvorlagen erstellen, aktualisieren und löschen können.

 


 

Certificates

Im Abschnitt Certificates der Learn365-API können Sie:

  • Informationen über Zertifikate auf dem Mandanten abrufen, beispielsweise die Zertifikats-ID, das Bild und die Benutzer, denen das jeweilige Zertifikat zuerkannt wurde
  • Zertifikate erstellen
  • Zertifikate erneut ausstellen
  • Zertifikatsbilder hochladen
  • Status sowie Ausstellungs- und Ablaufdatum eines Zertifikats ändern

 

Certificates_api.png

 

Weiterführende Artikel:

 

Competencies

HINWEIS

Für diese Endpunkte ist das Auslaufen am 18. August 2025 geplant. Wir empfehlen Ihnen, zu den neuen Skills-Endpunkten zu migrieren.

 

Der Abschnitt Competencies enthält API-Endpunkte, mit denen Sie eine Liste aller Qualifikationen auf dem Mandanten abrufen sowie Qualifikationen erstellen, aktualisieren und löschen können.

 


 

CompetencyCategories

HINWEIS

Für diese Endpunkte ist das Auslaufen am 18. August 2025 geplant. Wir empfehlen Ihnen, zu den neuen SkillCategories-Endpunkten zu migrieren.

 

Der Abschnitt CompetencyCategories enthält APIs, mit denen Sie eine Liste aller Qualifikationskategorien auf dem Mandanten abrufen sowie Qualifikationskategorien erstellen, aktualisieren und löschen können.

 

 

CompetencyScaleSets

HINWEIS

Für diese Endpunkte ist das Auslaufen am 18. August 2025 geplant. Wir empfehlen Ihnen, zu den neuen SkillScaleSets-Endpunkten zu migrieren.

 

Der Abschnitt CompetencyScaleSets enthält APIs, mit denen Sie eine Liste aller Qualifikationsgruppen auf dem Mandanten abrufen sowie Qualifikationsgruppen erstellen, aktualisieren und löschen können.

 


 

CompetencyTags

HINWEIS

Für diese Endpunkte ist das Auslaufen am 18. August 2025 geplant. Wir empfehlen Ihnen, zu den neuen SkillTags-Endpunkten zu migrieren.

 

Der Abschnitt CompetencyTags enthält API-Endpunkte, mit denen Sie eine Liste aller Qualifikations-Tags auf dem Mandanten abrufen sowie Qualifikations-Tags erstellen, aktualisieren und löschen können.

 


 

CourseCatalogs

Der Abschnitt CourseCatalogs enthält die API-Endpunkte, mit denen Sie neue Kurskataloge auf dem Mandanten erstellen, bestehende Kurskataloge oder Teile davon aktualisieren, eine Liste der Kurskataloge auf dem Mandanten einschließlich ihrer IDs abrufen, Benutzer zu Kurskatalogen hinzufügen oder daraus entfernen und Assets aus Kurskatalogen herunterladen können.

 


 

Weiterführende Artikel:

 

CourseCategories

Der Abschnitt CourseCategories enthält APIs, mit denen Sie Kategorien erstellen, aktualisieren und löschen sowie eine Liste der Kategorien auf dem Mandanten abrufen können.

 


 

Weiterführende Artikel:

 

CourseCompletionSets

Der Abschnitt CourseCompletionSets enthält APIs, mit denen Sie Kursabschluss-Sets erstellen, aktualisieren und löschen und eine Liste der Kursabschluss-Sets auf dem Mandanten abrufen können.

 


 

CourseImages

Der Abschnitt CourseImages enthält API-Endpunkte, mit denen Sie Bilder für Kurse und Kursbanner hochladen können.

 

 

CourseLayouts

Die API-Endpunkte im Abschnitt CourseLayouts werden nicht mehr unterstützt.

 

Courses

Der Abschnitt Courses enthält APIs, mit denen Sie eine Liste von Kursen (sowohl allgemein als auch Anfragen mit festgelegten Parametern) und verschiedene Details abrufen sowie Kurse erstellen, aktualisieren und löschen können. Ferner gibt es APIs, die es Ihnen ermöglichen, sich für Kurse zu registrieren, eine Kursregistrierung aufzuheben sowie Kursbewertungen und die Einstellungen für das Kursabschluss-Set zu verwalten. Sie können auch Kurssitzungen hinzufügen, aktualisieren und löschen.

 


 

Weiterführende Artikel:

 

CourseSessions

Der Abschnitt CourseSessions enthält API-Endpunkte, mit denen Sie eine Liste aller eigenständigen Sitzungen und Sitzungsgruppen auf dem Mandanten abrufen können.

 

2023-07-31 18_24_06-Swagger UI.png

 

Weiterführende Artikel:

 

CourseSessionRequests

Der Abschnitt CourseSessionRequests enthält APIs, mit denen Sie eine Liste aller Sitzungsanfragen auf dem Mandanten unter Berücksichtigung festgelegter Parameter abrufen sowie Kurssitzungsanfragen hinzufügen und löschen können.

 


 

CourseTags

Der Abschnitt CourseTags enthält APIs, mit denen Sie eine Liste aller Kurs-Tags auf dem Mandanten abrufen sowie Kurs-Tags erstellen, aktualisieren und löschen können.

 


 

EmailNotifications

Erforderliche Rolle: Katalogadministrator.

Der Abschnitt EmailNotifications enthält API-Endpunkte, mit denen Sie E-Mail-Benachrichtigungen verwalten können:

  • E-Mail-Benachrichtigungsvorlagen anhand ihrer ID abrufen
  • E-Mail-Benachrichtigungsvorlagen aktualisieren
  • Eine Liste aller Benachrichtigungsvorlagen für einen bestimmten Kurskatalog abrufen
  • E-Mail-Benachrichtigungsvorlagen auf Katalogebene aktivieren oder deaktivieren
  • Microsoft-Verbindungseinstellungen aktivieren oder deaktivieren
  • Angepasste Benachrichtigungsvorlagen auf die Standardeinstellungen zurücksetzen
  • Eine Liste von Kursbenachrichtigungen für eine E-Mail-Benachrichtigungsvorlage abrufen
  • Kursbenachrichtigung für eine E-Mail-Benachrichtigungsvorlage abrufen
  • E-Mail-Benachrichtigungsvorlagen auf Kursebene aktivieren oder deaktivieren
  • Eine Liste von Kursbenachrichtigungen für alle E-Mail-Benachrichtigungsvorlagen abrufen

 

E-Mail-Benachrichtigungen

 

EnrollmentFlows

Der Abschnitt EnrollmentFlows enthält APIs, mit denen Sie Informationen zu den Registrierungsflows auf dem Mandanten abrufen können.

 

 

Enrollments

Der Abschnitt Enrollments enthält APIs, mit denen Sie Registrierungen erstellen, zurückgeben, genehmigen, abbrechen, löschen und ablehnen sowie weitere Aktionen durchführen können.

 



Weiterführende Artikel:

 

ExternalApps

Der Abschnitt ExternalApps enthält API-Endpunkte, mit denen Sie eine Liste externer Apps auf dem Mandanten abrufen und externe Apps hinzufügen, ersetzen und löschen können. Außerdem können Sie die Position externer Apps in einem Kurs ändern.

 

 

Weiterführender Artikel:

 

ExternalTrainings

Der Abschnitt ExternalTrainings enthält API-Endpunkte, mit denen Sie Kurse, Schulungsfortschritte und Zertifikate in den Mandanten importieren können.

 


 

Weiterführender Artikel:

 

GroupRestrictions

Der Abschnitt GroupRestrictions enthält APIs, mit denen Sie die Sichtbarkeit von Benutzern aus Microsoft Entra-Gruppen (vormals Azure Active Directory-Gruppen) im Learn365 Admin Center einschränken können. Beispielsweise werden, wenn die Gruppenbeschränkungen aktiv sind, nur Benutzer aus bestimmten Microsoft Entra-Gruppen (vormals Azure Active Directory-Gruppen) angezeigt, wenn Lernende für eine Schulung registriert werden.

 


 

Weiterführender Artikel:

 

Groups

Der Abschnitt Groups enthält APIs, mit denen Sie benutzerdefinierte Benutzergruppen erstellen und löschen, Benutzer zu einer benutzerdefinierten Gruppe hinzufügen oder sie daraus entfernen und eine Liste von Gruppen bzw. eine Liste von Benutzern in einer Gruppe anzeigen können.

Benutzerdefinierte Benutzergruppen sind Gruppen, die Sie über die Learn365-API erstellen und verwalten können. Im Gegensatz zu Microsoft Entra-Gruppen können benutzerdefinierte Benutzergruppen Benutzer jeglicher Art (einschließlich Benutzer aus Learn365 und Flow365) umfassen.

 


 

Weiterführende Artikel:

 

LearningModuleAttempts

Der Abschnitt LearningModuleAttempts enthält API-Endpunkte, mit denen Sie eine Liste der Versuche von Benutzer zu Lernmodulen auf dem Mandanten abrufen sowie Versuche von Benutzern aktualisieren, löschen und neu erstellen können.

 


 

LearningModules

Der Abschnitt LearningModules enthält APIs, mit denen Sie eine Liste der Lernmodule aller Kurse auf dem Mandanten abrufen sowie Lernmodule erstellen, aktualisieren und löschen können.

 


 

Weiterführende Artikel:

 

QuestionPoolCategories

Der Abschnitt QuestionPoolCategories enthält APIs, mit denen Sie eine Liste der Fragenpoolkategorien auf dem Mandanten abrufen und neue Kategorien für Fragenpools erstellen können.


 

QuizAttempts

Der Abschnitt QuizAttempts enthält Endpunkte, mit denen Sie eine Liste der Quizversuche von Lernenden auf dem Mandanten einschließlich der von den Lernenden gegebenen Quizantworten abrufen können.

 

 

Weiterführende Artikel:

 

QuizQuestionPools

Der Abschnitt QuizQuestionPools enthält APIs, mit denen Sie eine Liste von Fragenpools auf dem Mandanten abrufen und neue Fragenpools erstellen können.

 

 

Quizzes

Der Abschnitt Quizzes enthält Endpunkte, mit denen Sie eine Liste von Quiz auf dem Mandanten einschließlich relevanter Quizdaten abrufen, ein Quiz aktualisieren oder löschen oder ein neues Quiz erstellen können.

 

 

Weiterführende Artikel:

 

RoleAssignments

Der Abschnitt RoleAssignments enthält APIs, mit denen Sie eine Liste der Rollen abrufen können, die Benutzern und Gruppen zugewiesen sind.

 

 

Weiterführende Artikel:

 

Reports

Der Abschnitt Reports enthält den API-Endpunkt, mit dem Sie Informationen zu den Kosten je Benutzer für Kurssitzungen auf dem Mandanten abrufen können. Außerdem können Sie einen Bericht zur Schulungsdauer für einen Lernenden erstellen.

 

 

Weiterführende Artikel:

 

ScormAttempts

Der Abschnitt ScormAttempts enthält API-Endpunkte, mit denen Sie eine Liste aller Versuche aller Benutzer in allen SCORMs auf dem Mandanten abrufen sowie SCORMs erstellen und aktualisieren können.

 


 

Weiterführender Artikel:

 

Scorms

Der Abschnitt Scorms enthält APIs, mit denen Sie ZIP-Dateien auf den Mandanten hochladen und darauf basierend Inhaltspakete erstellen können. Außerdem können Sie hiermit vorhandene SCORMs verwalten, einschließlich einer Liste der SCORMs und ihrer IDs, des Inhalts der SCORMs und der Inhalts-URL, die Position der SCORMs gegenüber anderen Lernelementen in Kursen ändern und Inhaltspakete löschen.

 

 

Weiterführende Artikel:

 

SkillCategories

Der Abschnitt SkillCategories enthält APIs, mit denen Sie eine Liste der Qualifikationskategorien auf dem Mandanten abrufen sowie Qualifikationskategorien erstellen, aktualisieren und löschen können.

 

 

Skills

Der Abschnitt Skills enthält API-Endpunkte, mit denen Sie eine Liste aller Qualifikationen auf dem Mandanten abrufen sowie Qualifikationen erstellen, aktualisieren und löschen können.

 

 

SkillScaleSets

Der Abschnitt SkillScaleSets enthält APIs, mit denen Sie eine Liste aller Qualifikationsgruppen auf dem Mandanten abrufen sowie Qualifikationsgruppen erstellen, aktualisieren und löschen können.

 

 

SkillTags

Der Abschnitt SkillTags enthält API-Endpunkte, mit denen Sie eine Liste aller Qualifikations-Tags auf dem Mandanten abrufen sowie Qualifikations-Tags erstellen, aktualisieren und löschen können.

 

 

TargetSkills

Der Abschnitt TargetSkills enthält API-Endpunkte, mit denen Sie eine Liste von Zielqualifikationsregeln auf dem Mandanten per API sowie Informationen über eine einzelne Regel und eine Liste von Regeln abrufen können, die für bestimmte Lernende definiert sind. Ferner können Sie über diese Endpunkte Zielqualifikationsregeln erstellen, aktualisieren und löschen.

 

 

Weiterführender Artikel:

 

TrainingPlans

Der Abschnitt TrainingPlans enthält API-Endpunkte, mit denen Sie eine Liste von Schulungsplänen (sowohl allgemeine als auch Anfragen mit festgelegten Parametern) abrufen und einen Kurs im Schulungsplan hinzufügen, ausschließen oder aktualisieren können.

 

the_training_plans_section.png

 

Weiterführende Artikel:

 

UserCompetencies

HINWEIS

Für diese Endpunkte ist das Auslaufen am 18. August 2025 geplant. Wir empfehlen Ihnen, zu den neuen UserSkills-Endpunkten zu migrieren.

 

Der Abschnitt UserCompetencies enthält APIs, mit denen Sie eine Liste aller Qualifikationen aller Benutzer auf dem Mandanten abrufen können.

 


 

Weiterführende Artikel:

 

UserFields

Der Abschnitt UserFields enthält API-Endpunkte, mit denen Sie Informationen zu den Spalten im Bereich Benutzer auf dem Mandanten abrufen, sie aktualisieren und löschen sowie Benutzerspalten erstellen können.

 

 

Weiterführende Artikel:

 

UserRanks

Der Abschnitt UserRanks enthält APIs, mit denen Sie Informationen zu den Benutzerranglisten auf dem Mandanten abrufen können. Diese basieren auf der Anzahl der jeweils erworbenen WBEs.


 

Users

Der Abschnitt Users enthält APIs, mit denen Sie eine Liste der Benutzer auf dem Mandanten abrufen sowie Informationen über Benutzer abrufen, löschen, zusammenführen und aktualisieren können.

 

HINWEIS

Für die folgenden Endpunkte im Abschnitt Users ist das Auslaufen am 18. August 2025 geplant:

  • POST /odata/v2/Users('{LoginName}')/GrantCompetency
  • POST /odata/v2/Users('{LoginName}')/RevokeCompetency
  • POST /odata/v2/Users('{LoginName}')/PurgeCompetency

Wir empfehlen Ihnen, zum jeweiligen der folgenden neuen UserSkills-Endpunkten zu migrieren:

  • POST /services/skills/catalog/{courseCatalogId}/UserSkills/User/{userLoginName}/GrantSkill
  • POST /services/skills/catalog/{courseCatalogId}/UserSkills/User/{userLoginName}/RevokeSkill
  • POST /services/skills/catalog/{courseCatalogId}/UserSkills/User/{userLoginName}/PurgeSkill

 

 

Weiterführende Artikel:

 

UserSkillRequest

Der Abschnitt UserSkillRequest enthält APIs, mit denen Sie eine Liste aller Qualifikationsanfragen für den derzeit angemeldeten Benutzer sowie Informationen über eine einzelne Qualifikationsanfrage für einen beliebigen Benutzer auf dem Mandanten abrufen können.

 

 

UserSkills

Der Abschnitt UserSkills enthält APIs, mit denen Sie eine Liste aller Qualifikationen aller Benutzer auf dem Mandanten abrufen sowie Benutzern Qualifikationen verleihen und entziehen sowie löschen können.

 

 

Weiterführende Artikel:

 

WaitingListRequests

Der Abschnitt WaitingListRequests enthält APIs, mit denen Sie Informationen zu Benutzerwartelistenanfragen abrufen sowie Wartelistenanfragen erstellen und löschen können.

 

 

WebHookRegistrations

Der Abschnitt WebHookRegistrations enthält API-Endpunkte, mit denen Sie Webhooks auf dem Mandanten abonnieren bzw. abbestellen, Informationen über die Webhooks der Benutzer abrufen, neue Webhooks registrieren und Webhook-Registrierungen aktualisieren und löschen können.

 

 

War dieser Beitrag hilfreich?
0 von 0 fanden dies hilfreich

Kommentare

Zu diesem Beitrag können keine Kommentare hinterlassen werden.