検索

【API】認定証IDの取得

  • 更新

ここでは、Learn365 APIを通じた認定証IDの取得について説明します。

このAPIでは、認定証に使用されたテンプレートのIDも取得でます。

手順：

1．APIにアクセスし、認証を行います。

https://api.365.systems/  にアクセスし、適切なAPIキーで認証されていることを確認してください。

2．エンドポイントを選択します。

Certificates セクションで以下のエンドポイントを選択し、右上の［Try it out］をクリックします。

GET /odata/v2/Certificates Returns the list of Certificates owned by current user

Get the ID of a certificate1.png

3．必要に応じて、パラメータを入力します。

クエリオプション パラメータ を設定して、データの絞り込みやレスポンスに追加のデータと詳細を含めることができます。

  • 特定のコースで付与される認定証のテンプレートを見つけたい場合：

$expand フィールドに「Course」と入力します。これにより、リクエストを実行するとレスポンスにコースのタイトルが含まれます。

Cntr+Fを使用して、レスポンスから目的のコースを検索し、このコースで使用された認定証テンプレートのIDを取得することができます。

  • 特定の認証テンプレートが設定されているコース、またはトレーニングプランを取得したい場合：

$filter フィールドに「Title eq 'certificate's template'」と入力します。'certificate's template' は該当する認証テンプレートのタイトルに置き換えます。

認定証のタイトルは、Learn365管理センター＞カタログ設定＞認定証テンプレートで確認できます。

リクエストを実行すると、レスポンスにはこの認定証テンプレートが設定されているコース、またはトレーニングプランが返されます。

Get the ID of a certificate2.png

  • 特定のユーザーに与えられた認定証のリストを取得したい場合

$filter フィールドに「UserId eq ID of the user」 を入力します。ID of the user は該当するユーザーのIDに置き換えます。

入力例：UserId eq 7af3f4b0-65dc-4dfd-a4dc-287733b61e6d

  • 特定のコースに関連する認定証のリストを取得したい場合

$filter フィールドに「CourseId eq ID of the course 」を入力します。ID of the course は該当するコースのIDに置き換えます。

入力例： CourseId eq 6bf3f3b0-65dc-4dfd-a4dc-287733b61e6d 

  • 特定のコースにおける特定のユーザーのすべての認定証を取得したい場合

$filter フィールドに「UserId」と「CourseID」の両方のパラメータを入力します。

入力例：UserId eq 7af3f4b0-65dc-4dfd-a4dc-287733b61e6d and CourseId eq 6bf3f3b0-65dc-4dfd-a4dc-287733b61e6d

3．［Execute］をクリックしてリクエストを実行します。

4．「Responses」ブロックで結果を確認します。

  • Code 2xx（202など）は、リクエストが正しく動作したことを示します。

Get the ID of a certificate3.png

  • クエリオプション パラメータが設定されていない場合、Response bodyにはIDを含むテナント上のすべての認定証のデータが含まれます。

Get the ID of a certificate4.png

  • クエリオプション パラメータが設定された場合、Response bodyには関連するデータのみが含まれます。認定証IDは、パラメータの設定に関わらず含まれます。

Get the ID of a certificate5.png

  • Ctrl+Fで特定の認定証を検索することができます。
  • Downloadオプションを使用すると、APIリクエストの結果をJSONフォーマットでローカルデバイスに保存できます