Learn365 APIを使用すると、コースカタログ内のアセットを表示およびダウンロードできます。
ここでいう「コースカタログ アセット」とは、Learn365管理センターのリッチテキストエディターを使用して、コースカタログレベル(例:コースカタログやトレーニング説明)にアップロードされたドキュメント、動画、画像などを指します。
これらのアセットは、Microsoft SharePointストレージおよびAzure Blob Storageのどちらに保存されている場合でも、API経由で表示およびダウンロードが可能です。
ここでは、Learn365 APIを使用してアセットを表示およびダウンロードするための手順について説明します。
アセットの名前またはパスを取得する
Learn365 APIには、アセットの表示やダウンロードを行うための複数のエンドポイントが用意されています。
ただし、これらを利用するには対象アセットの「ファイル名」または「ファイルパス」が必要です。
ファイル名やパスをAPI経由で取得するには、コースカタログIDが必要です。コースカタログIDはAPIを使用して取得できます。
詳しくは、「【API】コースカタログIDの取得」をご参照ください。
手順:
1.APIにアクセスし、認証を行います。
https://api.365.systems/ にアクセスし、適切なAPIキーで認証されていることを確認してください。
2.エンドポイントを選択します。
CourseCatalogs セクションで以下のエンドポイントを選択し、右上の[Try it out]をクリックします。
3. 「Id*」フィールドに、対象のコースカタログIDを入力します。
4.[Execute]をクリックしてリクエストを実行します。
5.「Responses」ブロックで結果を確認します。
- ステータスコード200が返され、レスポンス本文にアセット一覧が含まれている場合は成功です。
- 一覧には、選択したコースカタログに含まれるすべてのアセットが表示されます。
- 各アセットには「FileName」と「AbsoluteUrl」が含まれています。これらの情報を使用して、アセットの表示やダウンロードを行うことができます。
- エラーが発生した場合は、レスポンス本文にエラーオブジェクトが含まれます。このオブジェクトには、エラー内容を示すcodeとmessageが含まれており、問題の原因を確認することができます。
コースカタログ内のアセットを表示またはダウンロードする
手順:
1.APIにアクセスし、認証を行います。
https://api.365.systems/ にアクセスし、適切なAPI キーで認証されていることを確認してください。
2.エンドポイントを選択します。
以下のどちらかのエンドポイントを選択し、右上の[Try it out]をクリックします。
-
Assets セクション
GET/courseCatalog/SiteAssetByNameAsStream Downloads file from Catalog Assets as stream. -
CourseCatalogs セクション
GET/odata/v2/CourseCatalogs({Id})/SiteAssetByNameAsStream(fileName='{fileName}') Downloads file from Catalog Assets as stream.
3.「catalogId」または「Id」フィールド(選択したエンドポイントにより異なります)に、コースカタログIDを入力します。
※ コースカタログIDはAPIを使用して取得できます。詳しくは、「【API】コースカタログIDの取得」をご参照ください。
4. 「fileName」フィールドに、対象アセットのファイル名を入力します。
ファイル名の指定方法は、アセットの保存先によって異なります。
💠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」ブロックで結果を確認します。
- ステータスコード200が返され、レスポンス本文にアセットが含まれる場合は成功です。
- エラーが発生した場合は、レスポンス本文にエラーオブジェクトが含まれます。このオブジェクトには、エラー内容を示すcodeとmessageが含まれており、問題の原因を確認することができます。