Learn365 APIでは、コースカタログのアセットを表示およびダウンロードすることができます。
コースカタログ アセットとは、コースカタログやトレーニングの説明など、コースカタログレベルでリッチテキストエディタを介して Learn365 管理センターにアップロードされたドキュメント、ビデオ、画像を意味します。
Microsoft SharePoint ストレージと Azure Blobストレージのからのアセットは、API を通じて表示およびダウンロードすることができます。
ここでは、Learn365 API を通じたアセットの表示、ダウンロードについて説明します。
アセット名またはパスの検索
Learn365 API は、アセットの表示やダウンロードを可能にするエンド ポイントを提供します。
ただし、これらのエンド ポインを使用するには、アセットのファイル名またはファイルパスが必要です。
API を通じてファイル名を取得するには、コースカタログ ID が必要です。コースカタログ ID の取得についてはこちらを参照してください。
API を通じたファイル名またはファイルパスの取得、以下の手順に沿って行います。
1.https://api.365.systems/ にアクセスし、APIキーで認証します。
2.CourseCatalogs セクションに移動し、GET/odata/v2/CourseCatalogs({Id})/SiteAssetsList() Get List metadata information about files from the site assets エンドポイントを選択し、右上の「Try it out」を選択します。
3.クエリパラメータを入力します。
- Id*:コースカタログ IDを入力します。(このフィールドは入力必須です。)
4.「Execute」を選択してリクエストを実行します。
5.Responses ブロックで結果を確認します。
- Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
- Response body には、選択されたコースカタログのすべてのアセットが含まれます。
- リスト内の各アセットにはアセットを表示またはダウンロードするために必要な「FileName」と「AbsoluteUrl」パラメータが含まれます。
- エラーの場合、Response body には、問題を説明するコードとメッセージ キーを持つエラー オブジェクトが含まれます。
コースカタログからアセットを表示またはダウンロードする
API を通じたコースカタログのアセットの表示またはダウンロードは、以下の手順に沿って行います。
1.https://api.365.systems/ にアクセスし、APIキーで認証します。
2.以下のいずれかのエンドポイントの1つを選択します。
- Assets セクションに移動し、GET/courseCatalog/SiteAssetByNameAsStream
Downloads file from Catalog Assets as stream. エンドポイントを選択し、右上の「Try it out」を選択します。
- CourseCatalogs セクションに移動し、GET/odata/v2/CourseCatalogs({Id})/SiteAssetByNameAsStream(fileName='{fileName}')
Downloads file from Catalog Assets as stream. エンドポイントを選択し、右上の「Try it out」を選択します。
3.クエリ パラメータを入力します。
手順2で選択したエンドポインに応じて「catalogId」または「Id」フィールド にコースカタログIDを入力します。(このフィールドは入力必須です。
4.「fileName」フィールドに、アセットのファイル名を入力します。
Microsoft SharePoint ストレージまたは Azure Blob ストレージなど、アセット ストレージによって形式が異なる場合があります。
Azure Blob Storage からのアセット(URL に assetsstorage 部分がある)の場合は、次のように入力できます。
- 拡張子付きのファイル名(例:354567161.jpeg)
- 相対ファイル パス。(例:assetsstorage/75454f67-d907-4a43-b0f9-0c9c12277edf/354567161.jpeg.)
Microsoft SharePoint ストレージのアセット(URLにsharepointの部分がある)の場合は、次のように入力できます。
- 拡張子付きのファイル名(例:354567161.jpeg)
- SiteAssets への相対ファイル パス(例:d2d325ea8995467b9bfbb80a41df74f5/354567161.jpeg)
- 絶対URL。(例:https://test.sharepoint.com/sites/OrientationTraining/SiteAssets/ d2d325ea8995467b9bfbb80a41df74f5/354567161.jpeg.)
5.「Execute」を選択してリクエストを実行します。
6.Responses ブロックで結果を確認します。
- Code の下の2xx(202など)は、リクエストが正しく動作したことを示します。
- その他のエラーの場合、Response body には、問題を説明するコードとメッセージ キーを含むエラー オブジェクトが含まれます。