learningCourseActivity resource type
Namespace: microsoft.graph
Important
APIs under the /beta
version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.
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 learningCourseActivities | learningCourseActivity collection | Get a list of the learningCourseActivity objects (assigned or self-initiated) for a user. |
Create learningCourseActivity | learningCourseActivity | Create a new learningCourseActivity object. |
Get learningCourseActivity | 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 | learningCourseActivity | Update the properties of a learningCourseActivity object. |
Delete learningCourseActivity | 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. Possible values are: required , recommended , unknownFutureValue . 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. 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 is a JSON representation of the resource.
{
"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"
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for