获取 learningCourseActivity

2024-09-16

命名空间：microsoft.graph

使用学习提供程序的 ID 或 externalCourseActivityId 或用户的 courseActivityId 获取指定的 learningCourseActivity 对象。

全局服务	美国政府 L4	美国政府 L5 (DOD)	由世纪互联运营的中国
✅	❌	❌	❌

权限

为此 API 选择标记为最低特权的权限。只有在应用需要它时，才使用更高的特权权限。有关委派权限和应用程序权限的详细信息，请参阅权限类型。要了解有关这些权限的详细信息，请参阅权限参考。

权限类型	最低特权权限	更高特权权限
委派（工作或学校帐户）	LearningAssignedCourse.Read	LearningSelfInitiatedCourse.Read
委派（个人 Microsoft 帐户）	不支持。	不支持。
应用程序	LearningAssignedCourse.Read.All	LearningAssignedCourse.ReadWrite.All、LearningSelfInitiatedCourse.Read.All、LearningSelfInitiatedCourse.ReadWrite.All

HTTP 请求

若要根据特定学习课程活动的 ID 获取其主键 () ：

GET /employeeExperience/learningCourseActivities/{Id}

若要获取基于其 externalCourseActivityId 的特定学习课程活动 (辅助密钥) ：

GET /employeeExperience/learningProviders/{registrationId}/learningCourseActivities(externalCourseActivityId='{externalCourseActivityId}')

若要获取用户的学习课程活动的详细信息，请执行以下操作：

GET users/{user-id}/employeeExperience/learningCourseActivities/{id}

若要获取已登录用户的学习课程活动的详细信息，请执行以下操作：

GET me/employeeExperience/learningCourseActivities/{id}

可选的查询参数

此方法支持 $select 和其他 OData 查询参数来自定义响应。若要了解一般信息，请参阅 OData 查询参数。

请求标头

名称	说明
Authorization	持有者 {token}。必填。详细了解身份验证和授权。

请求正文

请勿提供此方法的请求正文。

响应

如果成功，此方法在响应正文中返回响应 200 OK 代码和 learningCourseActivity 对象。

如果失败，此方法将返回以下响应之一：

应用场景	HTTP 代码	代码	消息
实体不支持方法	405	methodNotAllowed	此实体类型不支持此方法。有关适用于此实体的方法，请参阅 Microsoft Graph 文档。
用户没有适当的权限范围	403	禁止访问 (Forbidden)	你的帐户无权访问此报表或数据。请与管理员联系以请求访问权限。
禁止访问 (Forbidden)	403	禁止访问 (Forbidden)	对于此请求，你没有足够的服务计划。
错误请求	400	badRequest	未为给定租户启用此提供程序。
错误请求	400	badRequest	你的请求存在问题。确保输入的 registrationId 对租户有效或已注册。
错误请求	404	notFound	请求的分配 ID 不存在。
内部服务器错误	500	internalServerError	内部服务器错误。
请求受限制	429	tooManyRequests	{“code”： “tooManyRequests”，“message”： “在 {noOfMinutes} 分钟后重试”}。
服务不可用	503	serviceUnavailable	{“code”： “serviceUnavailable”，“message”： “在 {noOfMinutes} 分钟后重试”}。

示例

示例 1：基于其 ID 获取学习课程活动

请求

以下示例演示了使用 ID 获取学习课程活动的请求。

GET https://graph.microsoft.com/v1.0/employeeExperience/learningCourseActivities/8ba2228a-e020-11ec-9d64-0242ac120003


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.EmployeeExperience.LearningCourseActivities["{learningCourseActivity-id}"].GetAsync();



mgc employee-experience learning-course-activities get --learning-course-activity-id {learningCourseActivity-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
learningCourseActivities, err := graphClient.EmployeeExperience().LearningCourseActivities().ByLearningCourseActivityId("learningCourseActivity-id").Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

LearningCourseActivity result = graphClient.employeeExperience().learningCourseActivities().byLearningCourseActivityId("{learningCourseActivity-id}").get();


const options = {
	authProvider,
};

const client = Client.init(options);

let learningCourseActivity = await client.api('/employeeExperience/learningCourseActivities/8ba2228a-e020-11ec-9d64-0242ac120003')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->employeeExperience()->learningCourseActivities()->byLearningCourseActivityId('learningCourseActivity-id')->get()->wait();


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.employee_experience.learning_course_activities.by_learning_course_activity_id('learningCourseActivity-id').get()

响应

以下示例显示了相应的响应。

HTTP/1.1 200 OK
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": null,
  "dueDateTime": {
    "dateTime": "2022-09-22T16:05:00.0000000",
    "timeZone": "UTC"
  },
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "id": "8ba2228a-e020-11ec-9d64-0242ac120003",
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learningProviderId": "13727311-e7bb-470d-8b20-6a23d9030d70",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "notes": {
    "contentType": "text",
    "content": "required assignment added for user"
  },
  "status": "notStarted"
}

示例 2：基于学习提供程序的 externalCourseActivityId 获取学习课程活动

请求

以下示例显示了使用外部课程活动 ID 获取学习课程活动详细信息的请求。

GET https://graph.microsoft.com/v1.0/employeeExperience/learningProviders/01e8f81b-3060-4dec-acf0-0389665a0a38/learningCourseActivities(externalCourseActivityId='12a2228a-e020-11ec-9d64-0242ac120002')


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.EmployeeExperience.LearningProviders["{learningProvider-id}"].LearningCourseActivitiesWithExternalcourseActivityId("{externalcourseActivityId}").GetAsync();



mgc employee-experience learning-providers learning-course-activities-with-externalcourse-activity-id get --externalcourse-activity-id {externalcourse-activity-id} --learning-provider-id {learningProvider-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
externalcourseActivityId := "{externalcourseActivityId}"
learningCourseActivities, err := graphClient.EmployeeExperience().LearningProviders().ByLearningProviderId("learningProvider-id").LearningCourseActivitiesWithExternalcourseActivityId(&externalcourseActivityId).Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

LearningCourseActivity result = graphClient.employeeExperience().learningProviders().byLearningProviderId("{learningProvider-id}").learningCourseActivitiesWithExternalcourseActivityId("{externalcourseActivityId}").get();

Snippet not available


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->employeeExperience()->learningProviders()->byLearningProviderId('learningProvider-id')->learningCourseActivitiesWithExternalcourseActivityId('{externalcourseActivityId}', )->get()->wait();


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.employee_experience.learning_providers.by_learning_provider_id('learningProvider-id').learning_course_activities_with_externalcourse_activity_id("{externalcourseActivityId}").get()

响应

以下示例显示了相应的响应。

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.learningAssignment",
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#learningProviders('01e8f81b-3060-4dec-acf0-0389665a0a38')/learningCourseActivities('8ba2228a-e020-11ec-9d64-0242ac120003')$entity",
  "assignedDateTime": "2021-05-11T22:57:17+00:00",
  "assignerUserId": "cea1684d-57dc-438d-a9d1-e666ec1a7f3d",
  "assignmentType": "required",
  "completedDateTime": null,
  "completionPercentage": null,
  "externalCourseActivityId": "12a2228a-e020-11ec-9d64-0242ac120002",
  "id": "8ba2228a-e020-11ec-9d64-0242ac120003",
  "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"
}

示例 3：获取用户学习课程活动的详细信息

请求

以下示例显示了获取用户学习课程活动详细信息的请求。

GET https://graph.microsoft.com/v1.0/users/7ba2228a-e020-11ec-9d64-0242ac120002/employeeExperience/learningCourseActivities/8ba2228a-e020-11ec-9d64-0242ac120003


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Users["{user-id}"].EmployeeExperience.LearningCourseActivities["{learningCourseActivity-id}"].GetAsync();



mgc users employee-experience learning-course-activities get --user-id {user-id} --learning-course-activity-id {learningCourseActivity-id}



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
learningCourseActivities, err := graphClient.Users().ByUserId("user-id").EmployeeExperience().LearningCourseActivities().ByLearningCourseActivityId("learningCourseActivity-id").Get(context.Background(), nil)


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

LearningCourseActivity result = graphClient.users().byUserId("{user-id}").employeeExperience().learningCourseActivities().byLearningCourseActivityId("{learningCourseActivity-id}").get();


const options = {
	authProvider,
};

const client = Client.init(options);

let learningCourseActivity = await client.api('/users/7ba2228a-e020-11ec-9d64-0242ac120002/employeeExperience/learningCourseActivities/8ba2228a-e020-11ec-9d64-0242ac120003')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->users()->byUserId('user-id')->employeeExperience()->learningCourseActivities()->byLearningCourseActivityId('learningCourseActivity-id')->get()->wait();


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.users.by_user_id('user-id').employee_experience.learning_course_activities.by_learning_course_activity_id('learningCourseActivity-id').get()

响应

以下示例显示了相应的响应。

HTTP/1.1 200 OK
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('8ba2228a-e020-11ec-9d64-0242ac120003')$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": "8ba2228a-e020-11ec-9d64-0242ac120003",
  "dueDateTime": {
    "dateTime": "2022-09-22T16:05:00.0000000",
    "timeZone": "UTC"
  },
  "learningContentId": "57baf9dc-e020-11ec-9d64-0242ac120002",
  "learningProviderId": "13727311-e7bb-470d-8b20-6a23d9030d70",
  "learnerUserId": "7ba2228a-e020-11ec-9d64-0242ac120002",
  "notes": {
    "contentType": "text",
    "content": "required assignment added for user"
  },
  "status": "notStarted"
}

通过

获取 learningCourseActivity

权限

HTTP 请求

可选的查询参数

请求标头

请求正文

响应

示例

示例 1：基于其 ID 获取学习课程活动

请求

响应

示例 2：基于学习提供程序的 externalCourseActivityId 获取学习课程活动

请求

响应

示例 3：获取用户学习课程活动的详细信息

请求

响应

反馈

其他资源