検索

Learn365 Cloud API セクションの概要と機能

  • 更新

Learn365 APIを利用することで、他のアプリケーションと連携し、組織の業務プロセスを効率化しながらビジネスパフォーマンスの向上を図ることができます。

Learn365 API のエンドポイントは、その目的や機能に応じてセクションごとに分類されています。

ここでは、各セクションに含まれる内容について説明します

 

補足：

各セクションはアルファベット順に並べられています。各セクションの説明は、そのセクションに含まれる API の一般的な機能に基づいており、クエリ オプションのパラメーターは設定されていません。

Learn365 API を利用するには、最初にログインする必要があります。

重要！Competency（コンピテンシー）は段階的に廃止されます。

新しい Skills エンドポイントが実装されており、将来的には従来の Competency エンドポイントは置き換えられる予定です。

Competency エンドポイントは、今後の Learn365 リリースで廃止になるまで引き続き利用できますが、将来の廃止に備え、問題を事前に解決できるよう、Competency から Skills エンドポイントへの早めの移行を推奨します。

 

API セッションリスト

 

Apps

Apps セクションのAPIを使用すると、テナント内のすべてのアプリケーションの一覧と、それぞれのIDを取得することができます。

以前は個別のアプリケーションとして使用されていましたが、現在は Learn365 ソリューションに組み込まれています。

API sections1.png

 

Assessments

Assessments セクションには、テナント内のアセスメント（評価）に関する情報を取得するための API エンドポイントが含まれています。

取得できる情報には、アセスメント ID、関連するコース ID、名称、説明、監督者、その他の設定などがあります。

また、このセクションのAPIを使用すると、アセスメント（評価）の作成・更新・削除・承認に加え、テナント内のアセスメント一覧の取得も可能です。

API sections2.png

 

Assets

Assets セクションには、アセットのダウンロードやアップロードを行うための API エンドポイントが含まれています。

ここでいうアセットとは、リッチテキストエディタを介してLearn365管理センターに追加できる、ドキュメント、動画、画像などを指します。例えば、トレーニングやラーニング モジュールの説明文などに使用されるものです。

AssetsAPI.png

関連記事：

Assignments

Assignments セクションには、新しいアサインメント（課題）の作成、テナント内のアサインメント一覧およびその ID の取得、さらにアサインメントを完了としてマークするためのAPIエンドポイントが含まれています。

API sections3.png

 

CertificateTemplates

CertificateTemplates セクションには、テナント内のすべての認定証テンプレートの一覧を取得、および認定証テンプレートの作成・更新・削除を行うための API エンドポイントが含まれています。

API sections4.png

 

Certificates

Certificates セクションに含まれる API では、以下のの操作を行うことができます。

  • テナント内の認定証の情報（ID、画像、およびその認定証を付与されたユーザーなど）の取得
  • 認定証の作成
  • 認定証の再発行
  • 認定証の画像のアップロード
  • 認定証のステータス、発行日、有効期限の更新

API sections5.png

関連記事：

Competencies に関連のエンドポイント

注記：

Competencies 関連のエンドポイントは、今後の Learn365 リリースで廃止される予定です。新しい Skills エンドポイントへの移行を推奨します。

Competencies

Competencies セクションには、テナント内のすべてのスキルの一覧を取得できるほか、スキルの作成・更新・削除を行うための  APIエンドポイントが含まれています。

API sections6.png

 

CompetencyCategories

CompetencyCategories セクションには、テナントにおけるスキル カテゴリーのリストの取得、スキルのカテゴリを作成、更新、削除するための APIエンドポイントが含まれています。

API sections7.png

 

CompetencyScaleSets

CompetencyScaleSets セクションには、テナントにおけるスキル レベル セットのリストの取得、スキル レベル セットを作成、更新、削除するための APIエンドポイントが含まれています。

API sections8.png

 

CompetencyTags

CompetencyTags セクションには、テナントにおけるスキルタグのリストの取得、スキルタグを作成、更新、削除するための API エンドポイントが含まれます。

API sections9.png

 

CourseCatalogs

CourseCatalogs セクションには、テナント内にコースカタログの新規作成、既存のコースカタログの更新を行うための API エンドポイントが含まれています。

また、テナント内のコースカタログの一覧やその ID の取得、コースカタログへのユーザーの追加 / 削除、コースカタログからアセットのダウンロードも可能です。

API sections10.png

関連記事：

CourseCategories

CourseCategories セクションには、カテゴリーの作成・更新・削除、およびテナント内のカテゴリ一覧を取得するための API エンドポイントが含まれています。

API sections11.png

関連記事：

CourseCompletionSets

CourseCompletionSets セクションには、コース完了セットの作成・更新・削除、およびテナント内のコースに関連する完了セットの一覧を取得するための API エンドポイントが含まれています。

API sections12.png

 

CourseImages

CourseImages セクションには、コースやコース バナー用の画像をアップロードするための API エンドポイントが含まれています。

API sections13.png

 

CourseLayouts

CourseLayoutsセクションの API エンドポイントは廃止されました。

 

Courses

Courses セクションには、コースのリスト（一般的なものとパラメータが設定されたもの）と各種詳細情報の取得、コースを作成、更新、削除するための API エンドポイントが含まれています。

また、コースへの登録・登録解除、コース評価の管理、コース完了設定を管理するための API エンドポイントも用意されています。
加えて、コースセッションの追加・更新・削除も行うことができます。

API sections14.png

関連記事：

CourseSessions

CourseSessions セクションには、テナントにおけるすべての単独のセッションおよびセッション グループのリストを取得するための API エンドポイントが含まれています。

API sections15.png

関連記事：

CourseSessionRequests

CourseSessionRequests セクションには、設定されたパラメータに基づいて、テナントにおけるすべてのセッション リクエスト リストの取得、コース セッション リクエストの追加、削除するための API エンドポイントが含まれています。

API sections16.png

 

CourseTags

CourseTags セクションには、テナントにおけるすべてのコースタグのリストの取得、コースタグの作成、更新、削除するための API エンドポイントが含まれています。

API sections17.png

 

Delegates

Delegates セクションには、組織内のすべての代理人およびそのチームメンバーの一覧を取得、代理人の割り当て・解除や、特定の代理人に属するチームメンバーの一覧を取得するための API エンドポイントが含まれています。

api-Delegates section.png

関連記事：

EmailNotifications

この操作必要なロール：カタログ管理者

EmailNotifications セクションには、メール通知を管理するための API エンドポイントが含まれています。

  • ID によるメール通知テンプレートの取得
  • メール通知テンプレートの更新
  • 特定のコースカタログのすべての通知テンプレートリストの取得
  • カタログ レベルでメール通知テンプレートを有効/無効にする
  • Microsoft 365 接続設定を有効/無効にする
  • カスタマイズした通知テンプレートのリセット
  • Eメール通知テンプレートにおけるコース通知のリストの取得
  • E メール通知テンプレートにおける特定のコース通知の取得
  • コース レベルでメール通知テンプレートを有効/無効にする
  • すべての Eメール通知テンプレートにおけるコース通知のリストの取得

EmailNotifications API.png

 

EnrollmentFlows

EnrollmentFlows セクションには、テナントにおける登録フローに関連する情報を取得するための API エンドポイントが含まれています。

API sections18.png

 

Enrollments

Enrollments セクションには、登録情報の取得、登録の作成、承認、却下、キャンセル、消去など各種操作を行うための API エンドポイントが含まれています。

API sections19.png

関連記事：

ExternalApps

ExternalApps セクションには、、テナントにおける外部アプリの取得、および外部アプリの追加・更新・削除するための API エンドポイントが含まれています。また、コース内での外部アプリの配置順を変更することもできます。

API sections20.png

 

ExternalTrainings

ExternalTrainings セクションには、コース、学習の進捗（完了）、認定証をテナントにインポートするための API エンドポイントが含まれています。

API sections21.png

関連記事：

GroupRestrictions

GroupRestrictions セクションには、Learn365 管理センターで Microsoft Entra グループのユーザーの表示を制限するための API エンドポイントが含まれています。

例えば、グループ制限がオンの場合、受講者をトレーニングに登録する際に、特定の Microsoft Entra グループに属するユーザーのみが表示されます。

API group restrictions section.png

関連記事：

Groups

Groups セクションには、カスタム ユーザー グループの作成と削除、カスタム グループへのユーザーの追加と削除、グループ リストの表示、グループ内のユーザーリストの表示をするための API エンドポイントが含まれています。

カスタム ユーザー グループは、Learn365 で作成および管理できるグループです。Microsoft Entra グループとは異なり、カスタム ユーザー グループには、Learn365 ユーザーと Flow365 ユーザーの両方を含めることができます。

API GroupsSection.png

関連記事：

LearningModuleAttempts

LearningModuleAttempts セクションには、テナントにおけるラーニング モジュールにおけるユーザーの試行履歴の取得、ユーザーの試行の更新、削除、また新しい試行を生成するための API エンドポイントが含まれています。

API sections22.png

 

LearningModules

LearningModules セクションには、テナントにおけるすべてのコースのラーニング モジュールの取得、およびラーニング モジュールの新規作成、更新、削除するための API エンドポイントが含まれています。

API sections23.png

関連記事：

ProxyManagers

ProxyManagers セクションには、テナント全体または特定のユーザーに対するプロキシ マネージャーの割り当ての取得、およびプロキシ マネージャーの割り当て、更新、削除するための API エンドポイントが含まれています。

プロキシ マネージャー自身は、GET /services/users/v2/ProxyManagers/{proxyManagerId} エンドポイントにアクセスして、自身の割り当てを取得できます。

api_proxy_managers.png

 

QuestionPoolCategories

QuestionPoolCategories セクションには、テナントにおける問題集のカテゴリリストの取得、および問題集に新しいカテゴリを作成するための API エンドポイントが含まれています。

API sections24.png

 

QuizAttempts

QuizAttempts セクションには、テナントにおける受講者のクイズの試行（受講者のクイズの解答を含む）を取得する API エンドポイントが含まれています。

API sections25.png

関連記事：

QuizQuestionPools

QuizQuestionPools セクションには、テナントにおける問題集の取得、および新しい問題集を作成するための API エンドポイントが含まれています。

API sections26.png

 

Quizzes

Quizzes セクションには、テナントにおけるクイズと関連するクイズ データの取得、クイズの更新、削除、新しいクイズを作成するための API エンドポイントが含まれています。

API sections27.png

関連記事：

RoleAssignments

RoleAssignments セクションには、ユーザーやグループに割り当てられたロールのリストを取得するための API エンドポイントが含まれています。

RoleAssignmentsAPI.png

 関連記事：

Reports

Reports セクションには、テナントにおけるセッションのユーザーあたりのコストに関する情報の取得と、受講者のトレーニング所要時間レポートを生成するための API エンドポイントが含まれています。

API sections28.png

関連記事：

ScormAttempts

ScormAttempts セクションには、テナントにおけるすべての SCORM に対するすべてのユーザーの試行リストの取得、および SCORM の作成、更新するための API エンドポイントが含まれています。

API sections29.png

関連記事：

Scorms

Scorms セクションには、テナントに .zipファイルをアップロードし、それを基にコンテンツ パッケージを作成するための API エンドポインが含まれています。また、SCORMとその ID、 SCORM コンテンツ、コンテンツ URL のリストの取得、コースの学習項目における  SCORM の配置の変更、コンテンツパッケージの削除など、既存の SCORM を管理することもできます。

API sections30.png

関連記事：

SkillCategories

SkillCategories セクションには、テナントにおけるスキルのカテゴリーの取得、およびカテゴリーの作成、更新、削除するための API エンドポイントが含まれています。

api_skillcategories.png

 

Skills

Skills セクションには、テナントにおけるすべてのスキルの取得、スキルの作成、更新、削除するための API エンドポイントが含まれています。

api_skills.png

 

SkillScaleSets

SkillScaleSets セクションには、テナントにおけるスキル レベルセットの取得、スキル レベルセットの作成、更新、削除するための API エンドポイントが含まれています。

api_skillscalesets.png

 

SkillTags

SkillTags セクションには、テナントにおけるスキル タグの取得、スキル タグの作成、更新、削除するための API エンドポイントが含まれています。

api_skilltags.png

 

TargetSkills

TargetSkills セクションには、テナントにおける目標スキルの定義や各定義に関する情報や特定の受講者に適用された定義の取得、および目標スキルの定義の作成、更新、削除するための API エンドポイントが含まれています。

api_targetskills.png

関連記事：

TrainingPlans

TrainingPlans セクションには、テナントにおけるトレーニング プラン（一般的なものとパラメータが設定されたもの）の取得、およびトレーニング プランへのコースの追加、トレーニング プランからのコースの削除、トレーニング プランを更新するための API エンドポイントが含まれています。

API sections31.png

関連記事：

UserCompetencies

注記：

UserCompetencies エンドポイント（Competencies 関連のエンドポイント）は、今後の Learn365 リリースで廃止される予定です。新しい Skills エンドポイントへの移行を推奨します。

UserCompetencie  セクションには、テナントにおけるすべてのユーザーが持つスキルを取得するための API が含まれています。

API sections32.png

関連記事：

UserFields

UserFields セクションには、テナントの Learn365 管理センター＞ユーザーとグループ＞ 「ユーザー」 画面に表示される情報の取得、および情報の更新、削除と、新しい列を作成するための API エンドポイントが含まれています。

API sections33.png

関連記事：

UserRanks

UserRanks セクションには、テナントにおいて、ユーザーが獲得したCEU数に基づくランキング情報を取得するための API エンドポイントが含まれています。

API sections34.png

 

Users

Users セクションには、テナントにおけるユーザーとユーザー情報の取得、およびユーザーの消去、統合、更新などを行うための API エンドポイントが含まれています。

注記：

次の Users エンドポイント（Competencies 関連のエンドポイント）は、今後の Learn365 リリースで廃止される予定です。

  • POST /odata/v2/Users('{LoginName}')/GrantCompetency
  • POST /odata/v2/Users('{LoginName}')/RevokeCompetency
  • POST /odata/v2/Users('{LoginName}')/PurgeCompetency

以下の、新しい UserSkills エンドポイントへの移行を推奨します。

  • POST /services/skills/catalog/{courseCatalogId}/UserSkills/User/{userLoginName}/GrantSkill
  • POST /services/skills/catalog/{courseCatalogId}/UserSkills/User/{userLoginName}/RevokeSkill
  • POST /services/skills/catalog/{courseCatalogId}/UserSkills/User/{userLoginName}/PurgeSkill

API sections35.png

関連記事：

UserSkillRequest

UserSkillRequest セクションには、現在サインインしているユーザーのすべてのスキル 申請の取得、およびテナントにおける任意のユーザーの特定のスキル申請に関する情報を取得するための API エンドポイントが含まれています。

api_userskillrequest.png

 

UserSkills

UserSkills セクションには、テナントにおけるすべてのユーザーのスキルの取得、およびユーザーに対してスキルの付与、取り消し、削除するための API エンドポイントが含まれています。

api_userskills.png

関連記事：

WaitingListRequests

WaitingListRequests セクションには、ユーザーのウエイトリストに関する情報の取得、およびユーザーをウエイトリストに追加、ウエイトリストから削除するための API エンドポイントが含まれています。

API sections36.png

 

WebHookRegistrations

WebHookRegistrations セクションには、テナントにおける WebHook へのサブスクライブと WebHookからのサブスクライブ解除、ユーザーの WebHook に関する情報の取得、新しいWebHookの登録、およびWebHook の登録の更新、削除するための API エンドポイントが含まれています。

API sections37.png