英語で読む

次の方法で共有


Microsoft Learn Catalog API の機能の概要

Microsoft Learn Catalog API は、Web ベースのクエリを Microsoft Learn に送信してトレーニング コンテンツと認定試験に関する詳細 (タイトル、対象製品、レベル、トレーニングへのリンク、その他のメタデータなど) を受け取るための REST ベース Web API であり、その情報が含まれる JSON エンコードされた応答が返されます。

以下のような、公開されているすべての情報を返します。

  • モジュール
  • ユニット
  • ラーニング パス
  • 適用されたスキル
  • 認定資格
  • 試験
  • 講師による指導付きコース

注意

最近の Microsoft Learn サイト更新プログラムの一環として、learn.microsoft.com ドメインで使用できる新しい Catalog API エンドポイントがあります。 古いエンドポイントでも引き続き、想定通りに動作しますが、新しいエンドポイントに切り替えると、クエリ パラメーターの追加など、機能が強化されるというメリットがあります。

ユース ケース

  • Microsoft Learn のトレーニングや認定資格のオファリングに関するメタデータを見る
  • Microsoft Learn のトレーニングや認定資格のオファリングに自分自身のオンライン エクスペリエンスからリンクするために、これらの一覧を取得する

Learn Catalog API のしくみ

この API は REST ベースの Web API であり、JSON エンコードされた応答を返します。 完全なカタログを要求するには、GET 要求を次の場所に送信します。

https://learn.microsoft.com/api/catalog/

出力は次のスクリーンショットのようになります。 2022 年 11 月の時点で、応答全体の大きさは約 13 MB です。

Screenshot of the Learn Catalog API output in Visual Studio Code.

ラーニング カタログのアイテムそれぞれが 1 つのオブジェクトであり、それぞれに一連のメタデータがあります。 完全なデータ ディクショナリとその他のオプションは、Microsoft Learn Catalog API 開発者向けドキュメントに記載されています。 また、最新の更新の内容がわかるリリース ノート (リンク) と、ベスト プラクティスの情報も用意されています。

実際に使用することに関心がある場合は、cURL と Visual Studio Code を利用して Microsoft Learn Catalog API の使用を開始することについての記事を参照してください。

必要条件

Microsoft Learn Catalog API にアクセスするために認証は必要ありません。 ユーザーは、cURL、Postman などの好みの API 要求メソッドを使用できます。

ユーザーはさまざまな方法で Learn Catalog API を使用していますが、そのいくつかを次に示します。

  • Viva ラーニングでは、その中核的エクスペリエンスの一部として Microsoft Learn カタログを提示するために Learn Catalog API が使用されています。
  • 組織や教育機関では、従業員や学生が簡単にアクセスできるようにカタログ情報をプルして内部のラーニング管理システム (LMS) に掲載するために、Learn Catalog API が使用されています。
  • 学習プロバイダーは、カタログ情報をプルして顧客のラーニング エクスペリエンスの中で提示するために Learn Catalog API を使用しています。

可用性と料金

Microsoft Learn Catalog API は一般公開されており、Microsoft API 使用条件の条件の下で提供されています。 この API の使用について料金が請求されることはありません。

制限事項

  • この API には、一般公開されているモジュール、ユニット、ラーニング パス、講師による指導付きコース、試験、認定資格が含まれています。 現時点では、ドキュメント、コード サンプル、ショー、イベントは出力されません。
  • この API は少なくとも 1 日に 1 回、最新の情報に更新されます。
  • API バージョンの更新については、Learn Catalog API のリリース ノートの更新を介してお知らせします。

次のステップ

Learn Catalog API についてさらに学ぶには、次の記事を参照してください。