ここでは、Learn365 API を通じた認定証 ID の取得について説明します。
この API では、認定証に使用されたテンプレートのIDも取得でます。
API を通じた認定証 ID の取得は、以下の手順に沿って行います。
1.https://api.365.systems/ にアクセスし、APIキーで認証します。
2.Certificates セクションに移動し、GET /odata/v2/Certificates Returns the list of Certificates owned by current user を選択し、右上の「Try it out」を選択します。
クエリ オプション パラメータを設定して レスポンス データを絞り込むことができます。クエリオプションパラメータが設定されると、レスポンスには検索に使用できる追加のデータと詳細が含まれます。
例:
- 特定のコースで付与される認定証のテンプレートを見つけるには、$expand フィールドに「Course」と入力します。この場合、リクエストを実行するとレスポンスにコースのタイトルが含まれます。
Cntr+Fを使用して、目的のコースを検索し、このコースで使用された認定証テンプレートのIDを取得することができます。
- 特定の認証テンプレートが設定されているコース、またはトレーニングプランを取得するには
$filter フィールドに「Title eq 'certificate's template'」と入力します。 'certificate's template' は該当する認証テンプレートのタイトルに置き換えます。 認定証のタイトルは、Learn365 管理センター>カタログ設定> 認定証テンプレートで確認できます。リクエストを実行すると、レスポンスには、この認定証テンプレートが設定されているコース、またはトレーニングプランのみが表示されます。
- 特定のユーザーに与えられた認定証のリストを取得するには、$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
-
UserId と CourseID を組み合わせると、レスポンスには、特定のコースに対する該当ユーザーのすべての認定証リストを取得できます。 この場合、$filter フィールドに両方のパラメータを設定します。
例:UserId eq 7af3f4b0-65dc-4dfd-a4dc-287733b61e6d and CourseId eq 6bf3f3b0-65dc-4dfd-a4dc-287733b61e6d
|
3.「Execute」を選択してリクエストを実行します。
4.Responses ブロックで結果を確認します。
- Code の下の2xx(202など)は、リクエストが正しく動作したことを示します。
- Ctrl+Fで特定の認定証を検索することができます。
- Downloadオプションを使用すると、APIリクエストの結果を JSON フォーマットでローカルデバイスに保存できます。
- クエリ オプション パラメータが設定されていない場合、Response body には ID を含むテナント上のすべての認定証のデータが含まれます。
- クエリ オプション パラメータが設定された場合、Response body には関連するデータのみが含まれます。認定証 ID は、パラメータの設定に関わらず含まれます。