外部学习模块最佳实践
本文列出了使中间件与 Genesys API 交互的最佳实践。
Genesys Cloud 可以将 Genesys Cloud 平台外部的系统同步到 Genesys 学习模块。
描述
To create a learning module, the administrator can use the following endpoint:
POST /learning/modules
指令
外部模块必须是指向外部学习资源的单个 URL。
示例
{
"name": "SMART goals",
"description": "This external training takes you through how to create SMART goals.",
"completionTimeInDays": 14,
"informSteps": [
{
"type": "Url",
"name": "SMART goals",
"order": 1,
"value": "https://myLms.com/courses/1234"
}
],
"excludedFromCatalog": true,
"externalId": "1234",
"type": "External"
}
描述
To publish a learning module, the administrator can use the following endpoint:
POST /api/v2/learning/modules/{moduleId}/publish
指令
如果您在发布后编辑学习模块，则必须再次重新发布该模块才能将更新版本的模块分配给用户。 您可以从目录中隐藏模块，以防止当主管通过工作区开发页面分配学习模块时它们显示在模块列表中。
描述
To assign a learning module, the administrator can use the following endpoint:
POST /api/v2/learning/assignments
指令
您可以向用户分配特定版本的学习模块。 学习模块的版本仅在用户开始作业时确定。 如果用户尚未开始分配并且发布了较新版本的模块，则最新版本的学习模块会自动分配给该用户。
示例
{
"moduleId": "2169a726-31e1-4d69-b161-1b62ccb1c99e",
"userId": "1e39d64f-68ff-41cc-8a2e-781cbce08409",
"recommendedCompletionDate": "2024-02-01T15:00:00Z",
"lengthInMinutes": "60"
}
描述
您可以从 Genesys Cloud 启动学习模块。 在作业启动期间，会出现一个带有模块描述和封面艺术的封面屏幕。
指令
当您单击开始作业时，您将被重定向到模块步骤中指向外部学习资源的 URL 。
描述
To update the assignment, the external system must send the results of the learning resource to Genesys Cloud via the following endpoint:
PATCH /api/v2/learning/modules/{moduleId}/users/{userId}/assignments
指令
The following endpoint is gated behind the learning:externalAssignment:edit permission that is not assigned to any roles by default:
PATCH /api/v2/learning/modules/{moduleId}/users/{userId}/assignments
The endpoint always updates the latest assignment for that user and the learning module.
示例
{
"state": "Completed",
"percentageScore": 85,
"isPassed": true
}
