System Status
  1. Zensai Hilfecenter
  2. Learn365
  3. REST API, Power BI und Power Automate
  4. Allgemeine Informationen zur API

Abschnitte der Learn365-API: Allgemeiner Überblick und Funktionen

Avatar

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 dass Abfrageoptionsparameter festgelegt wurden.
     
  • Um die Learn365-API nutzen zu können, müssen Sie sich zuerst anmelden.

WICHTIG   

Wir haben neue Qualifikation-Endpunkte implementiert, die die entsprechenden Competency-Endpunkte zu gegebener Zeit ersetzen werden. Sie können die bisherigen Competency-Endpunkte weiter verwenden, bis wir sie im Rahmen eines zukünftigen Learn365-Releases als veraltet einstufen.

Wir empfehlen Ihnen, bereits jetzt mit den Planungen für das Auslaufen der Competency-Endpunkte zu beginnen und zu den neuen Qualifikation-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 die APIs, mit denen Sie Informationen zu Bewertungen auf dem Tenant 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.

 

HINWEIS  

Die folgenden Endpunkte werden im Rahmen einer zukünftigen Learn365-Version eingestellt:

  • GET /odata/v2/Bewertungen
  • POST /odata/v2/Bewertungen
  • GET /odata/v2/Assessments({Id})
  • PUT /odata/v2/Assessments({Id})
  • DELETE /odata/v2/Assessments({Id})
  • POST /odata/v2/Assessments/Approve

 Wir empfehlen Ihnen, jeweils zu den folgenden neuen Endpunkten zu migrieren:

  • GET /services/learn/v2/Bewertungen
  • POST /services/learn/v2/Bewertungen
  • GET /services/learn/v2/Assessments/{id}
  • PUT /services/learn/v2/Assessments/{Id}
  • DELETE /services/learn/v2/Assessments/{Id}
  • POST /services/learn/v2/Assessments/approve

 

Bewertungs-Endpunkte in Swagger

 

Assets

Der Abschnitt Assets enthält die APIs, mit denen Sie Assets herunterladen und hochladen können. Mit Assets sind alle Dokumente, Videos oder Bilder gemeint, 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 die API-Endpunkte, die verwendet werden, um neue Zuweisungen zu erstellen, eine Liste von Zuweisungen auf dem Tenant sowie deren IDs abzurufen und Zuweisungen als abgeschlossen zu kennzeichnen.

 


 

 

CertificateTemplates

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

 


 

 

Zertifikate

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  

Diese Endpunkte werden im Rahmen eines zukünftigen Learn365-Releases als veraltet eingestuft. Wir empfehlen Ihnen, zu den neuen Qualifikation-Endpunkten zu migrieren.

 

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

 


 

 

CompetencyCategories

HINWEIS  

Diese Endpunkte werden im Rahmen eines zukünftigen Learn365-Releases als veraltet eingestuft. Wir empfehlen Ihnen, zu den neuen SkillCategories-Endpunkten zu migrieren.

 

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

 

 

CompetencyScaleSets

HINWEIS  

Diese Endpunkte werden im Rahmen eines zukünftigen Learn365-Releases als veraltet eingestuft. Wir empfehlen Ihnen, zu den neuen SkillScaleSets -Endpunkten zu migrieren.

 

Der Abschnitt CompetencyScaleSets enthält die APIs, mit denen Sie eine Liste der Qualifikationsstufengruppen auf dem Tenant abrufen sowie Qualifikationsstufengruppen erstellen, aktualisieren und löschen können.

 


 

 

CompetencyTags

HINWEIS  

Diese Endpunkte werden im Rahmen einer zukünftigen Learn365-Version als veraltet eingestuft. Wir empfehlen Ihnen, zu den neuen SkillTags-Endpunkten zu migrieren.

 

Der Abschnitt CompetencyTags enthält die API-Endpunkte, mit denen Sie eine Liste der Qualifikations-Tags auf dem Tenant 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 Tenant erstellen, bestehende Kurskataloge oder Teile davon aktualisieren, eine Liste der Kurskataloge auf dem Tenant und deren ID abrufen, Benutzer zu Kurskatalogen hinzufügen, Benutzer aus Kurskatalogen entfernen und Assets aus Kurskatalogen herunterladen können.

 


 

 

Weiterführende Artikel:

 

CourseCategories

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

 


 

 

Weiterführende Artikel:

 

CourseCompletionSets

Der Abschnitt CourseCompletionSets enthält die APIs, mit denen Sie Kursabschluss-Sets erstellen, aktualisieren und löschen sowie eine Liste der Kursabschluss-Sets für Kurse auf dem Tenant abrufen können.

 


 

 

CourseImages

Der Abschnitt CourseImages enthält die 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.

 

Kurse

Der Abschnitt Courses enthält die 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 die API-Endpunkte, mit denen Sie eine Liste aller eigenständigen Sitzungen und Sitzungsgruppen auf dem Tenant abrufen können.

 

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

 

Weiterführende Artikel:

 

CourseSessionRequests

Der Abschnitt CourseSessionRequests enthält die APIs, mit denen Sie eine Liste aller Sitzungsanfragen auf dem Tenant abhängig von den festgelegten Parametern abrufen sowie Kurssitzungsanfragen hinzufügen und löschen können.

 


 

 

CourseTags

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

 


 

 

Stellvertreter

Der Abschnitt Delegates enthält die APIs, mit denen Sie eine Liste aller Delegierten und ihrer Teammitglieder in Ihrer Organisation abrufen, Delegierte zuweisen und die Zuweisung aufheben sowie eine Liste der Teammitglieder eines bestimmten Delegierten anzeigen können.

 

The Delegates API section
 

Weiterführende Artikel:

 

EmailNotifications

Erforderliche Rolle: Katalogadministrator.

Der Abschnitt EmailNotifications enthält die 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
  • Die Microsoft Connection Settings. aktivieren und 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 die APIs, mit denen Sie Informationen zu den Registrierungsflows auf dem Tenant abrufen können.

 

 

Enrollments

Der Abschnitt Enrollments enthält APIs, mit denen Sie Registrierungen erstellen, abrufen, 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 im Tenant 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 Tenant importieren können.

 


 

 

Weiterführender Artikel:

 

GroupRestrictions

Der Abschnitt GroupRestrictions enthält APIs, mit denen Sie die Sichtbarkeit von Benutzern aus Microsoft Entra-Gruppen im Learn365 Admin Center einschränken können. Wenn die Gruppenbeschränkungen beispielsweise aktiv sind, werden bei der Registrierung von Lernenden für eine Schulung nur die Benutzer aus bestimmten Microsoft Entra-Gruppen angezeigt.

 


 

 

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 Benutzern in Lernmodulen im Tenant abrufen sowie Benutzerversuche aktualisieren und löschen und neue erstellen können.

 


 

 

LearningModules

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

 


 

 

Weiterführende Artikel:

 

ProxyManager

Der Abschnitt ProxyManagers enthält APIs, mit denen Sie eine Liste aller Proxy-Manager-Zuweisungen im Tenant oder für einen bestimmten Benutzer abrufen können. Damit können Sie auch Proxy-Manager-Zuweisungen erstellen, aktualisieren oder löschen.

Ein Proxy-Manager kann den GET-Endpunkt /services/users/v2/ProxyManagers/{proxyManagerId} ausführen, um eine Liste seiner eigenen Zuweisungen abzurufen.

 

api ProxyManager Abschnitt

 

 

QuestionPoolCategories

Der Abschnitt QuestionPoolCategories enthält APIs, mit denen Sie eine Liste der Fragenpoolkategorien im Tenant 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 im Tenant 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 im Tenant abrufen und neue Fragenpools erstellen können. 

 

 

Quizzes

Der Abschnitt Quizzes enthält Endpunkte, mit denen Sie eine Liste von Quiz im Tenant einschließlich relevanter Quizdaten abrufen, ein Quiz aktualisieren und löschen sowie ein neues 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 im Tenant abrufen können. Außerdem können Sie einen Bericht zur Schulungsdauer für einen Lernenden erstellen.

 

 

Weiterführende Artikel:

 

ScormAttempts

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

 


 

 

Weiterführender Artikel:

 

Scorms

Der Abschnitt Scorms enthält APIs, mit denen Sie ZIP-Dateien in den Tenant 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 section enthält APIs, mit denen Sie eine Liste der Qualifikationskategorien im Tenant abrufen sowie Qualifikationskategorien erstellen, aktualisieren und löschen können.

 

 

Qualifikationen

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

 

 

SkillScaleSets

Der SkillScaleSets -Abschnitt enthält APIs, mit denen Sie eine Liste der Qualifikationsstufengruppen auf dem Tenant abrufen sowie Qualifikationsstufengruppen erstellen, aktualisieren und löschen können.

 

 

SkillTags

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

 

 

TargetSkills

Der TargetSkills-Abschnitt enthält API-Endpunkte, mit denen Sie eine Liste von Zielqualifikationsregeln auf dem Tenant 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 TrainingPlans-Abschnitt 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  

Diese Endpunkte werden im Rahmen einer zukünftigen Learn365-Version eingestellt. Wir empfehlen Ihnen, zu den neuen UserSkills -Endpunkten zu migrieren.

 

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

 


 

 

Weiterführende Artikel:

 

UserFields

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

 

 

Weiterführende Artikel:

 

UserRanks

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


 

Users

Der Users-Abschnitt enthält APIs, mit denen Sie eine Liste der Benutzer auf dem Tenant abrufen sowie Benutzerinformationen abrufen, bereinigen, zusammenführen und aktualisieren können.

 

HINWEIS  

Die folgenden Users-Endpunkte werden im Rahmen einer zukünftigen Learn365-Version eingestellt:

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

 Wir empfehlen Ihnen, zu den 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 UserSkillRequest -Abschnitt 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 Tenant abrufen können.

 

 

UserSkills

Der UserSkills -Abschnitt enthält APIs, mit denen Sie eine Liste aller Qualifikationen aller Benutzer auf dem Tenant abrufen sowie Qualifikationen von Benutzern zuweisen, entziehen und bereinigen können

 

 

Weiterführende Artikel:

 

WaitingListRequests

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

 

 

WebHookRegistrations

Der WebHookRegistrations-Abschnitt enthält API-Endpunkte, mit denen Sie Webhooks auf dem Tenant 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.