learningCourseActivity を作成する

名前空間: microsoft.graph

新しい learningCourseActivity オブジェクトを 作成します。

ラーニング コース アクティビティには、次の 2 種類のいずれかを指定できます。

このメソッドを使用して、いずれかの種類のアクティビティを作成します。

: プロバイダーは、 isCourseAcitvitySyncEnabled が に設定されている場合にのみ学習コースアクティビティを true管理できます。 値を更新するには、 Update learningProvider メソッドを 使用します。

この API は、次の国内クラウド展開で使用できます。

グローバル サービス 米国政府機関 L4 米国政府機関 L5 (DOD) 21Vianet が運営する中国

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください

アクセス許可の種類 最小特権アクセス許可 特権の高いアクセス許可
委任 (職場または学校のアカウント) サポートされていません。 サポートされていません。
委任 (個人用 Microsoft アカウント) サポートされていません。 サポートされていません。
アプリケーション LearningAssignedCourse.ReadWrite.All LearningSelfInitiatedCourse.ReadWrite.All

HTTP 要求

POST /employeeExperience/learningProviders/{registrationId}/learningCourseActivities

要求ヘッダー

名前 説明
Authorization ベアラー {token}。 必須です。 認証と承認の詳細については、こちらをご覧ください。
Content-Type application/json. 必須です。

要求本文

要求本文で を使用 @odata.type して、作成する learningCourseActivity リソースの種類 (learningAssignment または learningSelfInitiated) を指定し、次の表に示すように、その型のプロパティを含めます。

プロパティ 説明
assignedDateTime DateTimeOffset コースアクティビティに割り当てられた日付。 省略可能です。
assignmentType assignmentType コース アクティビティの割り当てタイプ。 可能な値は requiredrecommendedunknownFutureValue です。 必須です。
assignerUserId String 担当者のMicrosoft Entra ID。 省略可能です。
CompletedDateTime DateTimeOffset 割り当てが完了した日時。 省略可能です。
completionPercentage Int32 ユーザーが完了したコースの割合。 省略可能です。 値を指定する場合は、 と 100 の間 0 (包括的) である必要があります。
dueDateTime DateTimeOffset コースアクティビティの期日。 省略可能です。
externalCourseActivityId String プロバイダーによって生成されたコース アクティビティ ID。 省略可能です。
id String コース アクティビティ API をさらに操作するために使用できる要求の生成された ID。
learningContentId String Viva Learningで作成された学習コンテンツの ID。 必須です。
learningProviderId String プロバイダーの登録 ID。 必須です。
learnerUserId String アクティビティが割り当てられている学習者のMicrosoft Entra ID。 必須です。
notes String コース アクティビティに関するメモ。 省略可能です。
registrationId String プロバイダーの ID。 ID は、プロバイダーがViva Learningに登録するときに生成されます。 必須です。
startedDateTime DateTimeOffset 学習者が自己開始コースを開始した日時。 省略可能です。
status courseStatus コース アクティビティの状態。 可能な値は notStartedinProgresscompleted です。 必須です。

応答

成功した場合、このメソッドは応答コードと、応答本文で learningAssignment 型または learningSelfInitiated 型の learningCourseActivity オブジェクトを返201 Createdします。

失敗した場合、このメソッドは次のいずれかの応答を返します。

シナリオ HTTP コード コード メッセージ 詳細
禁止されています 403 禁止されています この要求に対して適切なサービス プランがありません。
要求が正しくありません 400 badRequest このプロバイダーは、特定のテナントに対して有効になっていません。
要求が正しくありません 400 badRequest 要求に問題が発生しました。 入力した registrationId がテナントに対して有効または登録されていることを確認します。
内部サーバー エラー 500 internalServerError 内部サーバー エラー。
要求の調整 429 tooManyRequests {"code": "tooManyRequests","message": "Retry after {noOfMinutes} minutes"}。
サービスを使用できません 503 serviceUnavailable {"code": "serviceUnavailable","message": "Retry after {noOfMinutes} minutes"}。
複数のフィールド検証が失敗する 400 badRequest badRequest {"code": "badRequest","message": "入力フィールド {fieldName}は空にしないでください"}, {"code": "badRequest","message": "Input field {fieldName} is required"}, {"code": "badRequest","message": "Input field {fieldName}length exceeded than {expectedLength}"} 。
禁止されています 403 プロバイダーは、特定の学習コンテンツのコース アクティビティを作成するのに有効ではありません registrationId/learningProviderId が、learningContent が作成されるプロバイダーと一致しない場合。
禁止されています 403 ユーザー ライセンスが操作を実行するのに有効ではありません 割り当てを作成するユーザーに Premium ライセンスがない場合。

例 1: 割り当てられた学習コース アクティビティを作成する

次の例は、 learningAssignment アクティビティを作成する方法を示しています。

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/v1.0/employeeExperience/learningProviders/01e8f81b-3060-4dec-acf0-0389665a0a38/learningCourseActivities
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.learningAssignment",
  "assignedDateTime": "2021-05-11T22:57:17+00:00",
  "assignmentType": "required",
  "assignerUserId": "cea1684d-57dc-438d-a9d1-e666ec1a7f3d",
  "completedDateTime": null,
  "completionPercentage": 20,
  "dueDateTime": {
    "dateTime": "2022-09-22T16:05:00.0000000",
    "timeZone": "UTC"
  },
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learningProviderId": "01e8f81b-3060-4dec-acf0-0389665a0a38",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "notes": {
    "contentType": "text",
    "content": "required assignment added for user"
  },
  "status": "notStarted"
}

応答

次の例は応答を示しています。

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.learningAssignment",
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#learningProviders('13727311-e7bb-470d-8b20-6a23d9030d70')/learningCourseActivities('7ba2228a-e020-11ec-9d64-0242ac120002')$entity",
  "assignedDateTime": "2021-05-11T22:57:17+00:00",
  "assignmentType": "required",
  "assignerUserId": "cea1684d-57dc-438d-a9d1-e666ec1a7f3d",
  "completedDateTime": null,
  "completionPercentage": 20,
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "id": "7ba2228a-e020-11ec-9d64-0242ac120002:749c8786-99bb-4b3b-8d5d-586428f6aaa3",
  "dueDateTime": {
    "dateTime": "2022-09-22T16:05:00.0000000",
    "timeZone": "UTC"
  },
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learningProviderId": "01e8f81b-3060-4dec-acf0-0389665a0a38",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "notes": {
    "contentType": "text",
    "content": "required assignment added for user"
  },
  "status": "notStarted"
}

例 2: 自己開始型の学習コース アクティビティを作成する

次の例では、 learningSelfInitiated アクティビティを 作成します。

要求

次の例は要求を示しています。

POST https://graph.microsoft.com/v1.0/employeeExperience/learningProviders/01e8f81b-3060-4dec-acf0-0389665a0a38/learningCourseActivities
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.learningSelfInitiatedCourse",
  "completedDateTime": null,
  "completionPercentage": 20,
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "startedDateTime": "2021-05-21T22:57:17+00:00",
  "status": "inProgress"
}

応答

次の例は応答を示しています。

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.learningSelfInitiatedCourse",
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#learningProviders('13727311-e7bb-470d-8b20-6a23d9030d70')/learningCourseActivities('be2f4d76-e020-11ec-9d64-0242ac120002')$entity",
  "completedDateTime": null,
  "completionPercentage": 20,
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "id": "7ba2228a-e020-11ec-9d64-0242ac120002:749c8786-99bb-4b3b-8d5d-586428f6aaa3",
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learningProviderId": "01e8f81b-3060-4dec-acf0-0389665a0a38",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "startedDateTime": "2021-05-21T22:57:17+00:00",
  "status": "inProgress"
}