Einführung
Sie können Learn365 API-Endpunkte verwenden, um den Status von Lernmodulen und Quiz von „veröffentlicht“ auf „nicht veröffentlicht“ zu ändern – oder umgekehrt. So können Sie Inhalte für Lernende verfügbar oder nicht verfügbar machen, wenn sie einen Kurs absolvieren. Alternativ können Sie ein Lernobjekt (ein Lernmodul oder ein Quiz) direkt im Learn365 Admin Center bearbeiten, indem Sie dessen Veröffentlichungseinstellungen konfigurieren.
In diesem Artikel wird beschrieben, wie Sie Learn365 APIs verwenden können, um den Veröffentlichungsstatus von Lernmodulen und Quizzen eines Kurses zu ändern.
HINWEIS
Lernmodule sind jeweils nur einem bestimmten Kurs zugeordnet, daher wirkt sich eine Änderung des Veröffentlichungsstatus eines Lernmoduls nur auf diesen Kurs aus. Eine Änderung des Veröffentlichungsstatus eines Quiz wirkt sich auf alle Kurse im Katalog aus, die das Quiz verwenden.
Voraussetzungen
Um den Veröffentlichungsstatus von Lernmodulen und Quiz zu ändern, müssen Sie die relevanten Lernobjektdaten abrufen und anschließend eine Anfrage ausführen, um die Daten zu aktualisieren.
Für die Aktualisierungsanfrage müssen Sie einige Parameter eingeben, die Sie wie folgt erhalten können:
1. Gehen Sie zu https://api.365.systems/ und melden Sie sich mit dem entsprechenden API-Schlüssel an. Weitere Informationen zum Autorisierungsprozess finden Sie in diesem Artikel.
2. Suchen Sie in der Liste der Abschnitte der Learn365 API den passenden Abschnitt für das Lernobjekt, dessen Veröffentlichungsstatus Sie ändern möchten: LearningModules oder Quizzes.
3. Suchen Sie die entsprechende GET-Anfrage, mit der Sie die erforderlichen Parameter des betreffenden Lernobjekts abrufen:
- Suchen Sie für Lernmodule die GET-Methode /odata/v2/LearningModules
mit der Returns the list of Learning Modules
Beschreibung.
- Suchen Sie für Quizze die GET-Methode /odata/v2/Quizzes mit der Returns the list of Quizzes Beschreibung.
4. Erweitern Sie die entsprechende GET-Anfrage und wählen Sie Try it out aus.
5. Geben Sie im Feld $expand der entsprechenden GET-Methode den folgenden Wert ein, um die relevanten Datentypen in die Antwort einzuschließen:
- Geben Sie für Lernmodule Configuration, Publishing ein. Die Antwort enthält die Veröffentlichungseinstellungen der Lernmodule des Tenant sowie Daten zu den Elementen innerhalb der Lernmodule.
- Geben Sie für QuizzeA0Courses. ein Die Antwort enthält eine Liste der Kurse, in denen das Quiz verwendet wird.
Wenn Sie die ID oder den Titel eines Lernobjekts haben, können Sie die Antwort so eingrenzen, dass sie nur Daten zum relevanten Objekt enthält. Geben Sie dazu im Feld $filter Id eq item ID oder Title eq 'item title' ein, z. B. Id eq 90796418-a6e5-446c-96e5-00733621f771 oder entsprechend Title eq 'Phishing awareness guidelines'.
6. Wählen Sie Execute aus, um die Anfrage auszuführen.
7. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:
- Die Zahl 2xx (zum Beispiel 200) unter Code zeigt an, dass die Anfrage korrekt ausgeführt wurde. Sie können die Daten aus der Antwort über Download im .JSON-Format auf Ihren Computer herunterladen.
- Im Feld Response body sehen Sie Daten zu den Lernobjekten im gesamten Tenant. Suchen Sie das entsprechende Lernobjekt mit Strg+F.
Jetzt haben wir die Daten, die zum Aktualisieren des relevanten Lernobjekts erforderlich sind.
Veröffentlichungsstatus eines Lernobjekts aktualisieren
Lernmodul
HINWEIS
Die zum Aktualisieren der Details des Lernmoduls verwendete PUT-Methode ersetzt alle Informationen des Lernmoduls, nicht nur die von Ihnen angegebenen Details. Das bedeutet, dass alle Parameter angegeben werden müssen; andernfalls werden die nicht angegebenen Parameter mit leeren Daten überschrieben.
1. Suchen Sie den Abschnitt LearningModules, klappen Sie ihn auf, suchen Sie die PUT-Methode /odata/v2/LearningModules({Id}) mit der Beschreibung Updates Learning Module und wählen Sie Try it out aus.
2. Füllen Sie die Felder aus und beachten Sie dabei die Pflichtparameter:
-
key:Id, ein erforderlicher Parameter. Geben Sie hier die ID des Lernmoduls ein, für das Sie die Veröffentlichungseinstellungen aktualisieren möchten.
- Geben Sie im Feld Wert bearbeiten die Daten des Lernmoduls ein, die Sie im vorherigen Abschnitt ermittelt haben. Das folgende Beispiel zeigt nur das erwartete Format der Daten. Denken Sie daran, beim Ausfüllen der Parameter Ihre eigenen Daten zu verwenden. Achten Sie besonders auf den Parameter IsEnabled, denn true veröffentlicht das Lernmodul und false hebt die Veröffentlichung auf.
BEISPIEL
{
"Id": "90796418-a6e5-446c-96e5-00733621f771",
"CourseId": "7bb988b8-140a-4ee5-9141-5863868e719f",
"Title": "Richtlinien zur Sensibilisierung für Phishing, Einführung",
"Description": "In diesem Lernmodul erhalten Sie eine Einführung in einige der häufigsten Arten von Phishing-Angriffen.",
"IsPublished": true,
"Order": 4,
"HasPrerequisite": false,
"Configuration": {
"LearningModuleId": "90796418-a6e5-446c-96e5-00733621f771",
"Items": "[{\"ScormId\":\"0ff0c1db-886c-4ea7-b4d4-883ad86e9956\",\"ItemType\":2,\"PackageType\":0,\"Id\":\"0ff0c1db-886c-4ea7-b4d4-883ad86e9956\",\"Title\":\"Richtlinien zur Sensibilisierung für Phishing\",\"IsAvailable\":null,\"IsDeleted\":null}]"
},
"Publishing": {
"Id": "90796418-a6e5-446c-96e5-00733621f771",
"IsEnabled": false,
"StartDate": "2023-02-12T09:40:56Z",
"EndDate": null
}
}
3. Wenn Sie bereit sind, wählen Sie Execute aus, um die Anfrage auszuführen.
4. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren.
- Die Zahl 2xx (zum Beispiel 200) unter Code zeigt an, dass die Anfrage korrekt ausgeführt wurde.
-
Sie können die Ergebnisse im Learn365 Admin Center > wählen Sie einen Katalog > Schulungsverwaltung > wählen Sie den Kurs, der das relevante Lernmodul enthält > prüfen Sie den Veröffentlichungsstatus des Lernmoduls in der Spalte Veröffentlicht (Ja für veröffentlicht, Nein für nicht veröffentlicht).
Quiz
HINWEIS
- Die für das Aktualisieren der Quizdetails verwendete PUT-Methode ersetzt alle Quizinformationen, nicht nur die Details, die Sie angeben. Das bedeutet, dass alle Parameter angegeben werden müssen; andernfalls werden die nicht angegebenen Parameter ohne Daten überschrieben.
- Das Ändern des Veröffentlichungsstatus eines Quiz wirkt sich auf alle Kurse im Katalog aus, die das Quiz enthalten.
1. Suchen Sie den Abschnitt Quizzes, klappen Sie ihn auf, suchen Sie die PUT-Methode /odata/v2/Quizzes({Id}) mit der Beschreibung Updates a Quiz und klicken Sie auf Try it out.
2. Füllen Sie die Felder aus und beachten Sie dabei die Pflichtparameter:
- key:Id, einerforderlicher Parameter. Geben Sie hier die ID des Quiz ein, für das Sie die Veröffentlichungseinstellungen aktualisieren möchten.
- Geben Sie im Feld Wert bearbeiten die Daten des Quiz ein, die Sie im vorherigen Abschnitt ermittelt haben. Das folgende Beispiel zeigt nur das erwartete Format der Daten. Denken Sie daran, beim Ausfüllen der Parameter Ihre eigenen Daten zu verwenden. Achten Sie besonders auf den Parameter IsEnabled, da true das Quiz veröffentlicht und false es unveröffentlicht macht.
BEISPIEL
{
"Id": "7bd0e56d-c512-402d-bcf6-7895a5f8fc37",
"Title": "Teste dich selbst",
"Description": null,
"MaxAttemptsLimit": null,
"PassingPercentage": 10,
"IsPublished": false,
"PublishingStartDate": "2021-11-04T13:47:00Z",
"PublishingEndDate": null,
"Randomize": false,
"ShowScore": true,
"ShowCompletionScore": true,
"ShowPoints": false,
"AllowReview": true,
"AllowNavigation": false,
"ShowCorrectAnswers": false,
"ReviewMode": "DoNotShowAnyAnswers",
"TimeLimit": null,
"ShowTimer": false,
"Questions": "[{\"RightAnswer\":false,\"QuestionType\":2,\"Id\":\"bd64d7ec-262f-4d94-a41c-8e49235e3129\",\"Title\":\"Informationssicherheit \",\"Description\":\"\\\"Sie sollten niemals Inhalte in ein Lernmodul kopieren – verlinken Sie stattdessen auf die\\nonline-Inhalte.\\\" - Stimmt das?\",\"Points\":3,\"PositiveFeedback\":\"Das ist korrekt! Wenn\\nein Lernobjekt nicht aktualisiert werden soll – wie es oft bei\\nDokumenten oder Präsentationen der Fall ist – können Sie eine Kopie dieses Objekts bedenkenlos dem\\nLernmodul hinzufügen.\",\"NegativeFeedback\":\"Das ist nicht korrekt – bitte versuchen Sie es erneut!\",\"SemiPositiveFeedback\":null,\"Tags\":[]}]",
"ModifiedAt": "2022-08-16T10:43:30.603Z",
"CreatedAt": "2021-11-04T13:48:36.327Z"
}
3. Wenn Sie bereit sind, wählen Sie Execute aus, um die Anfrage auszuführen.
4. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren.
- Die Zahl 2xx (zum Beispiel 200) unter Code zeigt an, dass die Anfrage korrekt ausgeführt wurde.
- Sie können die Ergebnisse im Learn365 Admin Center > wählen Sie einen Katalog > Inhalt > Quizzes > wählen Sie das entsprechende Quiz > prüfen Sie den Veröffentlichungsstatus des Quiz in der Spalte Veröffentlicht (Ja für veröffentlicht, Nein für nicht veröffentlicht).
Kommentare
Zu diesem Beitrag können keine Kommentare hinterlassen werden.