Skip to content

learningcourseactivity.md

Latest commit

 

History

History
81 lines (67 loc) · 4.31 KB

learningcourseactivity.md

File metadata and controls

81 lines (67 loc) · 4.31 KB
title learningCourseActivity resource type
description Represents the activities that are part of an employee learning course.
author malabikaroy
ms.localizationpriority medium
ms.subservice viva-learning
doc_type resourcePageType
ms.date 07/22/2024

learningCourseActivity resource type

Namespace: microsoft.graph

Represents the activities that are part of an employee learning course.

Base type for the learningAssignment and learningSelfInitiated types.

Inherits from entity.

Methods

Method Return type Description
List learningCourseActivity collection Get a list of the learningCourseActivity objects (assigned or self-initiated) for a user.
Create learningCourseActivity Create a new learningCourseActivity object.
Get learningCourseActivity Get the specified learningCourseActivity object using either an ID or an externalCourseActivityId of the learning provider, or a courseActivityId of a user.
Update learningCourseActivity Update the properties of a learningCourseActivity object.
Delete None Delete a learningCourseActivity object by using the course activity ID of either an assignment or a self-initiated activity.

Properties

Property Type Description
assignedDateTime DateTimeOffset Date and time when the assignment was completed. Optional.
assignerUserId String The user ID of the assigner. Optional.
assignmentType assignmentType Assignment type for the course activity. The possible values are: required, recommended, unknownFutureValue, peerRecommended.Use the Prefer: include-unknown-enum-members request header to get the following value or values in this evolvable enum: peerRecommended. Required.
completedDateTime DateTimeOffset Date and time when the assignment was completed. Optional.
completionPercentage Int32 The percentage completion value of the course activity. Optional.
dueDateTime DateTimeTimeZone Due date for the course activity. Optional.
externalCourseActivityId String A course activity ID generated by the provider. Optional.
id String A generated ID that can be used with other course activity APIs.
learnerUserId String The user ID of the learner to whom the activity is assigned. Required.
learningContentId String The ID of the learning content created in Viva Learning. Required.
learningProviderId String The registration ID of the provider. Required.
startedDateTime DateTimeOffset Date and time when the self-initiated course was started by the learner. Optional.
status courseStatus The status of the course activity. The possible values are: notStarted, inProgress, completed. Required.

Note: A provider can ingest course activities when isCourseAcitvitySyncEnabled is set to true. To update the value, use the Update learningProvider method.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "assignedDateTime": "String (timestamp)",
  "assignerUserId": "String",
  "assignmentType": "String",
  "completedDateTime": "String (timestamp)",
  "completionPercentage": "Int32",
  "dueDateTime": "String (timestamp)",
  "externalCourseActivityId": "String",
  "id": "String (identifier)",
  "learnerUserId": "String",
  "learningContentId": "String",
  "learningProviderId": "String",
  "startedDateTime": "String (timestamp)",
  "status": "String"
}