検索

【API】 トレーニングプランへのコースの追加と削除

  • 更新

ここでは、Learn365 API を通じてトレーニング プランにコースを追加または削除する方法について説明します。

トレーニング プランのコースを確認する

先に、トレーニング プランに 現在どのようなコースがあるかを確認することをお勧めします。

これを行うには、トレーニング プラン の ID が必要です。トレーニングプランの ID の取得については、こちらをご参照ください。

API を通じたトレーニングプランのコースの取得は、以下の手順に沿って行います。

1． https://api.365.systems/  にアクセスし、API キーで認証します。

2． TrainingPlans セクションに移動し、GET /odata/v2/TrainingPlans({id})/Courses Gets all Courses of the Training Plan with related parameters エンドポイントを選択し、右上の［Try it out］をクリックします。

3．パラメータを入力します。

  • id＊：「Training Plan ID」フィールドに、トレーニングプラン ID を入力します。

必要に応じて、クエリ オプション パラメータを設定し、レスポンス データを絞り込むことができます。

4．［Execute］を選択してリクエストを実行します。

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

  • Code 2xx（202など）は、リクエストが正しく動作したことを示します。
  • Code 200で、Response body が空の場合、表示するデータがないことを意味します。
  • エラーの場合、Response body にはエラー オブジェクトとそのコード、問題を説明するメッセージ キーが含まれます。

 

トレーニング プランにコースを追加する

トレーニングプランにコースを追加するには、以下の情報が必要です。

API を通じたトレーニングプランへのコースの追加は、以下の手順に沿って行います。

1． https://api.365.systems/ にアクセスし、API キーで認証します。

2． TrainingPlans セクションに移動し、POST /odata/v2/TrainingPlans({id})/Courses({courseId}) Adds a Course to the Training Plan エンドポイントを選択し、右上の［Try it out］をクリックします。

3．パラメータを入力します。

  • id＊：「Training Plan ID」フィールドに、コースを追加するトレーニングプランの ID を入力します。
  • courseId＊：「Course ID」フィールドに、トレーニングプランに追加するコースの ID を入力します。
  • course＊：「Edit Value」フィールドに、以下のパラメータを入力します。
    • Order：トレーニングプラン内でのコースを配置する順番を数値（整数）で入力します。「0」はトレーニングプランの最初のコースです。順番が指定されない場合、このコースはトレーニングプランの最後に追加されます。
    • HasPrerequisite：「前提条件」の設定。「True」を設定すると、このコースはロックされ、前のコースを終了するとコースを開始することができます。「False」の場合、前のコースを終了にかかわらずコースを開始することができます。

注記：

既存のコースの順序をそのままにしてコースを追加する場合、既存のコースは順序は維持したまま、追加するコースに指定された順番に応じて移動されます。

たとえば、トレーニング プランには 以下の２つのコースがあります。

  1. The Onboarding course (Order: 0).
  2. The Communication course (Order: 1).

このトレーニング プランに「Set Up Your Laptop」コースを Order: 0 で追加します。

この場合、既存のコースは自動的に 1ステップ繰り下がります。

その結果、トレーニング プランのコースは以下の順序になります。

  1. The Set Up Your Laptop course (Order: 0)
  2. The Onboarding course (Order: 1)
  3. The Communication course (Order: 2)

course＊：「Edit Value」フィールドの入力例：

{
"Order": 0,
"HasPrerequisite": false
}

 

パラメータを入力例：

AddCourseToPlanRequest.png

 

4．［Execute］を選択してリクエストを実行します。

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

  • Code 2xx（202など）は、リクエストが正しく動作したことを示します。
  • エラーの場合、Response body にはエラー オブジェクトとそのコード、問題を説明するメッセージ キーが含まれます。

 

トレーニング プランからコースを削除する

トレーニングプランからコースを削除するには、次のものが必要です。

API を通じたトレーニングプランからのコースの削除は、以下の手順に沿って行います。

1． https://api.365.systems/ にアクセスし、API キーで認証します。

2． TrainingPlans セクションに移動し、DELETE /odata/v2/TrainingPlans({id})/Courses({courseId}) Excludes a Course from the Training Plan エンドポイントを選択し、右上の［Try it out］をクリックします。

3．パラメータを入力します。

  • id＊：「Training Plan ID」フィールドに、コースを削除するトレーニングプランの ID を入力します。
  • courseId＊：「Course ID」フィールドに、トレーニングプランから削除するコースの ID を入力します。

4．［Execute］を選択してリクエストを実行します。

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

  • Code 2xx（204 など）は、リクエストが正しく動作したことを示します。
  • エラーの場合、Response body にはエラー オブジェクトとそのコード、問題を説明するメッセージ キーが含まれます。