Freigabeeinstellungen für Inhaltspakete per API konfigurieren

Einführung

Sie können die Freigabeeinstellungen eines SCORM- oder AICC-Inhaltspakets direkt im Learn365 Admin Center oder über die Endpunkte der Learn365-API konfigurieren. Dieser Artikel beschreibt, welche API verwendet werden kann, um die aktuellen Freigabeeinstellungen eines Inhaltspakets zu überprüfen, und mit welcher API Sie die Freigabeeinstellungen des Inhaltspakets konfigurieren oder aktualisieren können.

 

SCORM-Daten (einschließlich der Freigabeeinstellungen) abrufen

Gehen Sie wie folgt vor, um Daten zu einem SCORM-Inhaltspaket (einschließlich der aktuellen Freigabeeinstellungen) abzurufen:

1. Gehen Sie zu https://api.365.systems/, und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind. Weitere Informationen zum Autorisierungsvorgang finden Sie in diesem Artikel.

2. Suchen und erweitern Sie den Abschnitt Scorms, wählen Sie die Methode GET /odata/v2/SCORMs mit der Beschreibung Returns the list of Scorms, und klicken Sie auf Try it out.

3. Damit die Antwort die Freigabeeinstellungen des betreffenden Inhaltspakets enthält, geben Sie Sharing in das Feld $expand ein.

Sie können die Antwort durch Konfigurieren des Feldes $filter eingrenzen:

• Wenn Sie die ID des betreffenden SCORM-Pakets haben, geben Sie Id eq SCORM_ID ein, wobei SCORM_ID durch die entsprechende Information ersetzt werden muss. Beispiel: Id eq 2d1e1525-5c04-45d6-9c72-048333f2f6c1.
• Wenn Ihnen der Titel des betreffenden SCORM-Pakets vorliegt, geben Sie Title eq 'SCORM-Titel' ein, wobei SCORM-Titel durch die entsprechende Information ersetzt wird. Beispiel: Title eq 'A Useful Guide to Appraisals'.

4. Wenn Sie bereit sind, wählen Sie Execute aus, um die Anfrage auszuführen.

 

 

5. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Die Zahl 2xx (beispielsweise „200“) unter Code zeigt an, dass die Anfrage korrekt funktioniert hat.
• Im Feld Response body sehen Sie die Inhaltspakete des Mandanten (einschließlich ihrer Daten) sowie deren Freigabeeinstellungen. Suchen Sie mit STRG+F nach dem gewünschten Inhaltspaket.
• Die Antwort enthält Informationen zu Inhaltspaketen, die etwaig festgelegten Filterparametern entsprechen.

 

 

6. Kopieren Sie alle Daten des betreffenden Inhaltspakets, da Sie diese im weiteren Verlauf des Vorgangs zur Ausführung der Aktualisierungsanfrage benötigen werden.

7. Über Download können Sie die Daten aus der Antwort im JSON-Format auf Ihren Computer herunterladen.

 

Freigabeeinstellungen konfigurieren

 

Durch das Konfigurieren der Freigabeeinstellungen eines Inhaltspakets über die API können Sie die Möglichkeit der Freigabe für einen bestimmten Kurskatalog oder Kurs hinzufügen oder entfernen oder die Freigabe auf dem Mandanten konfigurieren.

Führen Sie zu diesem Zweck die folgenden Schritte durch:

1. Suchen und erweitern Sie den Abschnitt Scorms, wählen Sie die Methode PUT /odata/v2/Scorms({Id}) mit der Beschreibung Updates a SCORM aus und klicken Sie auf Try it out.

2. Füllen Sie die Felder aus:

• key: Id ist ein Pflichtparameter. Geben Sie hier die ID des Inhaltspakets ein, für das Sie die Einstellungen aktualisieren möchten.
• Geben Sie im Feld Edit Value alle Anfrageparameter ein und verwenden Sie dazu die Antwort aus dem vorangegangenen Abschnitt.

3. Konfigurieren Sie unter Sharing die Freigabeeinstellungen nach Ihren Bedürfnissen:

• Id ist ein optionaler Parameter. Diese ID wird automatisch vom System generiert.
• AccessType ist ein Pflichtparameter. Ersetzen Sie string durch den Zugriffstyp, den Sie festlegen möchten: Read, Edit oder FullControl (Lesen, Bearbeiten oder Vollzugriff).
• SharingType ist ein Pflichtparameter. Ersetzen Sie string durch den festzulegenden Freigabebereich: Courses (zum Freigeben des Inhaltspakets für die ausgewählten Kurse), CourseCatalogs (zum Konfigurieren der Kataloge, für die Sie das Inhaltspaket freigeben möchten) oder Tenant (zum Freigeben des Inhaltspakets für alle Kataloge auf dem Mandanten).
• EntityId ist ein Pflichtparameter. Ersetzen Sie string durch die ID des entsprechenden Kurses oder Katalogs für die Freigabetypen Courses bzw. CourseCatalogs. Wenn der Freigabetyp Tenant ausgewählt ist, ersetzen Sie string durch null.
• EntityTitle ist ein Pflichtparameter. Ersetzen Sie string durch den Titel des entsprechenden Kurses oder Katalogs für die Freigabetypen Courses bzw. CourseCatalogs. Wenn der Freigabetyp Tenant ausgewählt ist, ersetzen Sie string durch null.

Nachstehend sind einige Anfragen zum Konfigurieren der Freigabeeinstellungen eines Inhaltspakets mit Beispielen aufgeführt:

• Zum Entfernen der Freigabe für einen Katalog löschen Sie im Teil Sharing jegliche Parameter, die sich auf den betreffenden Katalog beziehen, und führen dann die Anfrage aus.

 

• Zum Einschließen eines Katalogs in die Freigabeeinstellungen des Inhaltspakets fügen Sie dem Teil Sharing die Parameter hinzu, die sich auf den betreffenden Katalog beziehen, und führen dann die Anfrage aus.

 

• Zum Hinzufügen der Freigabe zu einem Kurs fügen Sie dem Teil Sharing die Parameter hinzu, die sich auf diesen Kurs beziehen, und führen dann die Anfrage aus.

 

• Zum Konfigurieren der Freigabe für den gesamten Mandanten fügen Sie entweder die relevanten Parameter hinzu, um die Freigabe für alle Kataloge im Mandanten zu ermöglichen, oder Sie entfernen die Parameter, um die Freigabe auf die Kataloge des Mandanten zu begrenzen.

 

4. Wenn Sie bereit sind, wählen Sie Execute aus, um die Anfrage auszuführen.

Hier sehen Sie ein Beispiel für eine Anfrage zur Aktualisierung der Freigabeeinstellungen eines Inhaltspakets. Dabei wird das Inhaltspaket für einen bestimmten Kurs und zwei Kataloge freigegeben.

 

 

5. Gehen Sie zum Block Response, um die Ergebnisse zu kontrollieren:

• Die Zahl 2xx (beispielsweise „200“) unter Code zeigt an, dass die Anfrage korrekt funktioniert hat.
• Im Feld Response body sehen Sie die Daten des Inhaltspakets einschließlich der aktualisierten Freigabeeinstellungen.
• Sie können die Ergebnisse unter Learn365 Admin Center > Inhalt > Inhaltspaketspeicher > relevantes Inhaltspaket auswählen > Inhaltspaket bearbeiten einsehen und die Freigabeeinstellungen überprüfen.