Kurskatalog-Assets über die Learn365-API anzeigen und herunterladen

Mit der Learn365-API können Sie die Assets aus Ihren Kurskatalogen anzeigen und herunterladen. Mit Kurskatalog-Assets meinen wir alle Dokumente, Videos oder Bilder, die im Learn365 Admin Center über den Rich-Text-Editor auf Kurskatalogebene hochgeladen wurden, zum Beispiel in Kurskatalog- oder Schulungsbeschreibungen. Assets sowohl aus dem Microsoft SharePoint-Speicher als auch aus dem Azure Blob Storage können per API angezeigt und heruntergeladen werden.

In diesem Artikel beschreiben wir die Schritte, die Sie befolgen sollten, um Assets über die Learn365-API anzuzeigen und herunterzuladen.

Asset-Name oder -Pfad ermitteln

Die Learn365-API stellt verschiedene Endpunkte bereit, mit denen Sie Assets anzeigen und herunterladen können. Um einen dieser Endpunkte zu nutzen, benötigen Sie jedoch den Dateinamen oder den Dateipfad des Assets.

Um einen Dateinamen per API zu ermitteln, benötigen Sie eine Kurskatalog-ID. Sie können dies per API über die Schritte in diesem Artikel herausfinden.

So erhalten Sie einen Dateinamen oder Dateipfad:

1. Gehen Sie zu https://api.365.systems/, und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Wählen Sie im Abschnitt CourseCatalogs den Endpunkt GET /odata/v2/CourseCatalogs({Id})/SiteAssetsList() aus und wählen Sie oben rechts Try it out aus.

3. Geben Sie im Feld Id die ID des Kurskatalogs ein.

4. Wählen Sie Execute aus, um die Anfrage auszuführen.

5. Wechseln Sie zum Block Response, um die Ergebnisse zu prüfen:

• Ein 200-Code mit einer Liste von Assets im Antworttext weist auf eine erfolgreiche Antwort hin. Die Liste enthält alle Assets für den ausgewählten Kurskatalog. Jedes Asset in dieser Liste enthält die Parameter FileName und AbsoluteUrl, die Sie zum Anzeigen oder Herunterladen des Assets benötigen.

  

• Im Fehlerfall enthält der Antworttext das Fehlerobjekt mit den Schlüsseln code und message, die das Problem erklären.

Asset aus einem Kurskatalog anzeigen oder herunterladen

So zeigen Sie ein Asset aus einem Kurskatalog an oder laden es herunter:

1. Gehen Sie zu https://api.365.systems/ und vergewissern Sie sich, dass Sie mit dem entsprechenden API-Schlüssel autorisiert sind.

2. Select eines dieser Endpoints:

• Wählen Sie im Abschnitt Assets den Endpunkt GET /courseCatalog/SiteAssetByNameAsStream aus und wählen Sie oben rechts Try it out aus.
• Wählen Sie im Abschnitt CourseCatalogs den Endpunkt GET /odata/v2/CourseCatalogs({Id})/SiteAssetByNameAsStream(filename=’{fileName}’) aus und wählen Sie oben rechts Try it out aus.

3. Geben Sie im Feld catalogId oder Id (je nachdem, welchen Endpunkt Sie in Schritt 2 gewählt haben) die Kurskatalog-ID ein.

4. Geben Sie im Feld fileName den Dateinamen eines Assets ein. Das Format kann je nach Asset-Speicher unterschiedlich sein: Microsoft SharePoint-Speicher oder Azure Blob Storage.

Für Assets aus Azure Blob Storage (sie haben den Teil assetsstorage in ihrer URL) können Sie Folgendes eingeben:

• einen Dateinamen mit Erweiterung, z. B. 354567161.jpeg.
• einen relativen Dateipfad, z. B. assetsstorage/75454f67-d907-4a43-b0f9-0c9c12277edf/354567161.jpeg.

Für Assets aus dem Microsoft SharePoint-Speicher (sie haben den Teil sharepoint in ihrer URL) können Sie Folgendes eingeben:

• einen Dateinamen mit Erweiterung, z. B. 354567161.jpeg.
• einen Dateipfad relativ zu SiteAssets, z. B. d2d325ea8995467b9bfbb80a41df74f5/354567161.jpeg.
• eine absolute URL, z. B. https://test.sharepoint.com/sites/OrientationTraining/SiteAssets/d2d325ea8995467b9bfbb80a41df74f5/354567161.jpeg.

5. Wählen Sie Execute aus, um die Anfrage auszuführen.

6. Gehen Sie zum Response-Block, um die Ergebnisse zu prüfen:

• Ein 200-Code mit einem Asset im Body weist auf eine erfolgreiche Response hin.

  

• Im Fehlerfall enthält der Antworttext das Fehlerobjekt mit den Schlüsseln code und message, die das Problem erklären.