APIで学習項目の公開ステータスを変更する

  • 更新

LMS365では、LMS365 管理センターのラーニングモジュール、クイズの公開設定、またはLMS365 API を使用して、ラーニングモジュールやクイズを公開から未公開(またはその反対)に変更することができます。これにより、受講者がコースを受講する際、コンテンツを利用可能にしたり、利用不可にすることができます。

ここでは、LMS365 APIを使用して、コースのラーニングモジュール、クイズの公開ステータスを変更する方法についてご説明します。

ラーニングモジュールは特定のコースに固有の学習項目であるため、公開ステータスの変更はこのコースのみに適用されます。
クイズの公開ステータスを変更すると、カタログ内でこのクイズを使用するすべてのコースに適用されます。

前提条件

ラーニングモジュールとクイズの公開ステータスを変更するには、それらの学習項目のデータを取得し、それらを更新するリクエストを実行する必要があります。

更新リクエストには、いくつかのパラメータの入力が必要です。パラメータに設定する値は、以下の方法で取得できます。

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

2.LMS365 Cloud APIセクション リストで、公開ステータスを変更する学習項目のセクション(LearningModules または Quizzes)を展開します。

3.以下の GET リクエストを選択します。

  • Learning modules の場合:  GET /odata/v2/LearningModules Returns the list of Learning Modules 
  • Quizzes の場合:GET /odata/v2/Quizzes Returns the list of Quizzes

開いた画面で右上の「Try it out」を選択します。

4.パラメータを入力します。$expand フィールドに以下の値を入力し、レスポンスに該当するデータを含めます。

ラーニングモジュールの場合「Configuration,Publishing」と入力します。
レスポンスには、テナントのラーニングモジュールの公開設定と、ラーニングモジュール内のアイテムに関するデータが含まれます。

クイズの場合「Courses」を入力します。レスポンスには、クイズが使用されているコースのリストが含まれます。

学習項目のIDまたはタイトルでフィルタリングし、レスポンスに、目的の学習項目に関するデータのみを含めることができます。

$filter フィールドに「Id eq item ID」または「Title eq 'item title'」と入力します。

item ID、item title は学習項目のID、タイトルに置き換えます。

例:「Id eq 90796418-a6e5-446c-96e5-00733621f771」/「Title eq 'Phishing awareness guidelines'」

5.準備ができたら、「Execute 」ボタンを選択してリクエストを実行します。

6.Responses ブロックで結果を確認します。

  • Codeの下にある2XX(例:200)という数字は、リクエストが正しく動作したことを示します。
  • Response body には、テナント全体の学習項目に関するデータが表示されます。Ctrl+Fで、目的の学習項目を検索します。

ダウンロードを選択してリクエストの結果を.JSONフォーマットでコンピュータに保存します。
これにより、公開ステータスを更新するリクエストを実行する際に、この情報を引用することができます。

学習項目の公開ステータスを更新する

Learning module

ラーニングモジュールの情報の更新に使用するPUTメソッドは、入力された詳細情報だけでなく、すべてのラーニングモジュールの情報を更新します。そのため、パラメータはすべて指定する必要があり、指定されていないパラメータはデータなしの状態で上書きされますので注意してください。

1.LearningModules セクションを展開し、 PUT /odata/v2/LearningModules({Id})  Updates Learning Module を選択し、開いた画面で右上の「Try it out」を選択します。

2.パラメータを設定します。

  • key:Id:このパラメータは必須です。公開設定を更新するラーニングモジュールのIDを入力します。

Edit Value フィールドで、前項で取得したラーニングモジュールの情報を入力します。

IsEnabled パラメータに十分注意してください。「true」はラーニングモジュールが公開され、「false」は公開しません。

次の例では、想定される更新データの形式を示しています。入力するパラメータの値は、お客様のデータに置き換えてください。

{
"Id": "90796418-a6e5-446c-96e5-00733621f771",
"CourseId": "7bb988b8-140a-4ee5-9141-5863868e719f",
"Title": "Phishing awareness guidelines, introduction",
"Description": "In this learning module you will be given an introduction to some of the most common phishing attack types.",
"IsPublished": true,
"Order": 4,
"HasPrerequisite": false,
"Configuration": {
"LearningModuleId": "90796418-a6e5-446c-96e5-00733621f771",
"Items": "[{\"ScormId\":\"0ff0c1db-886c-4ea7-b4d4-883ad86e9956\",\"ItemType\":2,\"PackageType\":0,\"Id\":\"0ff0c1db-886c-4ea7-b4d4-883ad86e9956\",\"Title\":\"Phishing awareness guidelines\",\"IsAvailable\":null,\"IsDeleted\":null}]"
},
"Publishing": {
"Id": "90796418-a6e5-446c-96e5-00733621f771",
"IsEnabled": false,
"StartDate": "2023-02-12T09:40:56Z",
"EndDate": null
}
}

update lm request1.png

3.準備ができたら、「Execute 」ボタンを選択してリクエストを実行します。

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

  • Codeの下にある2XX(例:204)という数字は、リクエストが正しく動作したことを示します。
  • Response headersで、リクエストの結果を見ることができます。
  • この結果は、LMS365管理センター>トレーニング管理>コース設定パネルのコンテンツセクションで、該当するラーニングモジュールの公開列(公開:はい/未公開:いいえ)で確認できます。

update lm request2.pngQuiz

クイズの情報の更新に使用するPUTメソッドは、入力された詳細情報だけでなく、すべてのクイズの情報を更新します。そのため、パラメータはすべて指定する必要があり、指定されていないパラメータはデータなしの状態で上書きされますので注意してください。

クイズの公開ステータスを変更すると、そのクイズを含むカタログ内のすべてのコースに適用されます。

1.Quizzes セクションを展開し、PUT  /odata/v2/Quizzes({Id})  Updates a Quiz を選択し、開いた画面で右上の「Try it out」を選択します。

2.パラメータを設定します。

  • key:Id:このパラメータは必須です。公開設定を更新するクイズのIDを入力します。

Edit Value フィールドで、前項で取得したクイズの情報を入力します。

IsEnabled パラメータに十分注意してください。「true」はクイズが公開され、「false」は公開しません。

次の例では、想定される更新データの形式を示しています。入力するパラメータの値は、お客様のデータに置き換えてください。

{
"Id": "7bd0e56d-c512-402d-bcf6-7895a5f8fc37",
"Title": "Test yourself",
"Description": null,
"MaxAttemptsLimit": null,
"PassingPercentage": 10,
"IsPublished": false,
"PublishingStartDate": "2021-11-04T13:47:00Z",
"PublishingEndDate": null,
"Randomize": false,
"ShowScore": true,
"ShowCompletionScore": true,
"ShowPoints": false,
"AllowReview": true,
"AllowNavigation": false,
"ShowCorrectAnswers": false,
"ReviewMode": "DoNotShowAnyAnswers",
"TimeLimit": null,
"ShowTimer": false,
"Questions": "[{\"RightAnswer\":false,\"QuestionType\":2,\"Id\":\"bd64d7ec-262f-4d94-a41c-8e49235e3129\",\"Title\":\"Information Security \",\"Description\":\"\\\"You should never copy any content to a learning module - instead, link to the\\nonline content.\\\" - Is that so?\",\"Points\":3,\"PositiveFeedback\":\"That's correct! If\\na learning item is not expected to be updated - as is often the case with\\ndocuments or presentations - you can safely add a copy of that item to the\\nlearning module.\",\"NegativeFeedback\":\"That's incorrect - please try again!\",\"SemiPositiveFeedback\":null,\"Tags\":[]}]",
"ModifiedAt": "2022-08-16T10:43:30.603Z",
"CreatedAt": "2021-11-04T13:48:36.327Z"
}

3.準備ができたら、「Execute 」ボタンを選択してリクエストを実行します。

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

  • Codeの下にある2XX(例:204)という数字は、リクエストが正しく動作したことを示します。
  • Response headersで、リクエストの結果を見ることができます。
  • この結果は、LMS365管理センター>コンテンツ>クイズで、該当するクイズの公開列(公開:はい/未公開:いいえ)で確認できます。