Freigabeeinstellungen von Inhaltspaketen über die Learn365-API konfigurieren

Einführung

Sie können die Freigabeeinstellungen eines SCORM- oder AICC-Inhaltspakets direkt im Learn365 Admin Center oder über 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, suchen Sie die GET-Methode /odata/v2/Scorms mit der Beschreibung Returns the list of Scorms und wählen Sie Try it out aus.

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 haben, geben Sie Id eq SCORM ID ein, wobei SCORM ID durch die entsprechenden Daten ersetzt wird, z. B. Id eq 2d1e1525-5c04-45d6-9c72-048333f2f6c1.
• Wenn Sie den Titel des betreffenden SCORM haben, geben Sie Title eq 'SCORM title' ein, wobei SCORM title durch die entsprechenden Daten ersetzt wird, z. B. 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 Responses , um die Ergebnisse zu überprüfen.

• Die Zahl 2xx (beispielsweise „200“) unter Code zeigt an, dass die Anfrage korrekt funktioniert hat. 
• Im Feld Response body sehen Sie die Inhaltspakete des Tenant (einschließlich ihrer Daten) sowie deren Freigabeeinstellungen. Suchen Sie über Strg+Fnach 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. ÜberDownload 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, suchen Sie die PUT-Methode /odata/v2/Scorms({Id}) mit der Beschreibung Updates a SCORM , und wählen Sie Try it out aus.

2. Füllen Sie die Felder aus:

• key: Id ist ein erforderlicher Parameter. Geben Sie hier die ID des Inhaltspakets ein, für das Sie die Einstellungen aktualisieren möchten.
• Geben Sie im Feld Edit Value alle Parameter der Anfrage ein und verwenden Sie dazu die Daten aus der Antwort im obigen 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 erforderlicher Parameter. Ersetzen Sie string durch den Zugriffstyp, den Sie festlegen möchten: Read, Edit oder FullControl.
• SharingType, ein erforderlicher Parameter. Ersetzen Sie string durch den Freigabebereich, den Sie festlegen möchten: Courses (um das Inhaltspaket für die ausgewählten Kurse freizugeben), CourseCatalogs (um die Kataloge zu konfigurieren, für die Sie das Inhaltspaket freigeben möchten) oder Tenant (um das Inhaltspaket für alle Kataloge des Tenants freizugeben).
• EntityId, ein erforderlicher Parameter. Ersetzen Sie string durch die ID des entsprechenden Kurses oder Katalogs für die Freigabetypen Courses und CourseCatalogs. Wenn der Freigabetyp Tenant ausgewählt ist, ersetzen Sie string durch null. 
• EntityTitle, ein erforderlicher Parameter. Ersetzen Sie string durch den Titel des entsprechenden Kurses oder Katalogs für die Freigabetypen Courses und 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:

• Um die Freigabe für einen Katalog zu entfernen, löschen Sie im Teil Sharing alle Parameter, die sich auf den betreffenden Katalog beziehen, und führen Sie dann die Anfrage aus.

• Um einen Katalog in die Freigabeeinstellungen des Inhaltspakets einzuschließen, fügen Sie dem Teil Sharing die Parameter hinzu, die sich auf diesen Katalog beziehen, und führen Sie dann die Anfrage aus.

• Um die Freigabe für einen Kurs hinzuzufügen, fügen Sie dem Teil Sharing  die Parameter hinzu, die sich auf diesen Kurs beziehen, und führen Sie dann die Anfrage aus.

• Um die Freigabe für den gesamten Tenant zu konfigurieren, fügen Sie entweder die relevanten Parameter hinzu, um die Freigabe für alle Kataloge im Tenant zu aktivieren, oder entfernen Sie die Parameter, um die Freigabe auf die Kataloge des Tenants zu beschränken.

4. Wenn Sie bereit sind. klicken Sie auf Ausführen, 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 Responses, um die Ergebnisse zu kontrollieren:

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