# 学习地图管理

# 学习地图分页列表

# 功能说明

分页查询学习地图列表

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/map/page

方式：get

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
name	String	否	新员工培养计划	学习地图名称
usingState	Integer	否	1	发布状态（1.已发布；2.未发布）
classifyId	String	否	7d34db5339c64c54b	分类id
pageNum	Integer	是	1	请求页码
pageSize	Integer	是	10	每页条数
orderField	String	否	createTime	排序字段，支持按人数、创建时间、权重排序
orderDirection	String	否	desc	排序方向

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
total	Integer	26	总条数
pageNum	Integer	1	请求页码
pageSize	Integer	10	每页条数
size	Integer	10	当前页的记录数
id	Integer	9115	学习地图id
name	String	新员工培养计划	学习地图名称
usingState	Integer	1	发布状态（1.已发布；2.未发布）
createTime	Date	1742175585000	创建时间（时间戳）
finishedUserNum	Integer	86	完成人数
eventType	Integer	0	学习地图类型：0.学习地图 1.新员工培训
timingType	Integer	0	计时方式：0.固定时间/统一时间 1.指定天数 2.不限制时间
timingLimit	Integer	30	指定完成天数，仅指定天数时有效
timingLimitType	Integer	1	指定天数的计时方式(1.按开始学习时间计算 2.按邀请时间计算)
classifyId	String	7d34db5339c64c54b3c7	分类id
classifyName	String	新员工培训	分类名称
totalStudyDuration	Integer	480	总学习时长
weight	Integer	100	权重

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/map/page?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&pageNum=1&pageSize=10&name=新员工培养计划

正常返回示例

JSON格式

{
    "code": "200",
    "body": {
        "pageNum": 1,
        "pageSize": 2,
        "nextPage": 2,
        "total": 120,
        "pages": 60,
        "list": [
            {
                "id": 10180,
                "name": "地图回调0127[复制]",
                "finishedUserNum": 0,
                "usingState": 2,
                "createTime": 1775738111000,
                "eventType": 0,
                "timingType": 2,
                "timingLimit": 5,
                "timingLimitType": 1,
                "creatorId": "60d063e5e85a4ba792c468094cc1875d",
                "creatorType": 1,
                "creatorName": "刘禹锡",
                "thirdType": 8,
                "totalStudyDuration": 45,
                "weight": 1000
            },
            {
                "id": 10179,
                "name": "地图证书11[复制]",
                "finishedUserNum": 0,
                "usingState": 2,
                "createTime": 1775738105000,
                "eventType": 0,
                "timingType": 2,
                "timingLimit": 5,
                "timingLimitType": 1,
                "classifyId": "11d588ed92b54d28b251348f401d786c",
                "classifyName": "fasd",
                "creatorId": "60d063e5e85a4ba792c468094cc1875d",
                "creatorType": 1,
                "creatorName": "刘禹锡",
                "thirdType": 8,
                "totalStudyDuration": 0,
                "weight": 1000
            }
        ],
        "isLastPage": false,
        "size": 120,
        "isFirstPage": true
    }
}

# 学习地图详情

# 功能说明

查询指定学习地图详情

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/map/detail

方式：get

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
mapId	Integer	是	9115	学习地图id

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	json	如下字段	学习地图详情信息
id	Integer	9115	学习地图id
name	String	新员工培养计划	学习地图名称
coverUrl	String	https://pic.qsy.com/map001.png	封面图地址
description	String	面向新员工的系统化学习地图	学习地图简介
usingState	Integer	1	发布状态（1.已发布；2.未发布）
createTime	Date	1742175585000	创建时间（时间戳）
publishTime	Date	1742262000000	发布时间（时间戳）
startTime	Date	1742313600000	开始时间（时间戳）
endTime	Date	1744905600000	结束时间（时间戳）
eventType	Integer	0	学习地图类型：0.学习地图 1.新员工培训
timingType	Integer	0	计时方式：0.固定时间/统一时间 1.指定天数 2.不限制时间
timingLimit	Integer	30	指定完成天数，仅指定天数时有效
timingLimitType	Integer	1	指定天数的计时方式(1.按开始学习时间计算 2.按邀请时间计算)
classifyId	String	7d34db5339c64c54b3c7e2	分类id
classifyName	String	新员工培训	分类名称
totalStudyDuration	Integer	480	总学习时长

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/map/detail?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&mapId=9115

正常返回示例

JSON格式

{
    "code": "200",
    "body": {
        "id": 10180,
        "factoryCode": "126891",
        "name": "地图回调0127[复制]",
        "usingState": 2,
        "jsonData": {
            "enableCredit": false,
            "credit": 0,
            "theme": 1,
            "gameTheme": 1,
            "type": 1,
            "taskLockWay": 0,
            "taskLockDuration": 0,
            "taskLockDurationUnit": 1,
            "timingType": 2,
            "timingLimit": 5,
            "timingLimitType": 1,
            "leaderTeach": 0,
            "managerTeachEnable": 0,
            "hrbpTeach": 0,
            "trainBpTeach": 0,
            "allowExpire": 0,
            "isComment": 0,
            "isCommentPublicCredit": 0,
            "commentPublicCreditType": 1,
            "commentPublicDailyCreditTimes": 1,
            "commentPublicCreditNum": 1,
            "isCommentReplyCredit": 0,
            "commentReplyCreditType": 1,
            "commentReplyDailyCreditTimes": 1,
            "commentReplyCreditNum": 1,
            "durationCalAdjustPlaySpeed": 0,
            "forbidDragVedio": 0,
            "forbidAdjustPlaySpeed": 0
        },
        "creatorId": "60d063e5e85a4ba792c468094cc1875d",
        "createTime": 1775738111000,
        "creatorType": 1,
        "eventType": 0,
        "timingType": 2,
        "timingLimit": 5,
        "timingLimitType": 1,
        "totalStudyDuration": 45
    }
}

# 学习地图阶段任务列表

# 功能说明

查询学习地图下的阶段任务列表

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/map/periodTask/list

方式：get

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
mapId	Integer	是	9115	学习地图id

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	Array	如下字段	学习地图阶段任务列表
id	String	9108eb40731d4a2cb6d21d71bb0f1001	阶段id（mapTaskList中为任务id）
mapId	Integer	9115	学习地图id
name	String	入职准备	阶段名称
sortIndex	Integer	1	阶段排序（mapTaskList中为任务排序）
startTime	Date	1742313600000	阶段开始时间（时间戳）
endTime	Date	1742918400000	阶段结束时间（时间戳）
mapTaskList	Array	如下字段	阶段任务列表
periodId	String	9108eb40731d4a2cb6d21d71bb0f1001	所属阶段id
eventName	String	企业文化课程	任务名称
eventId	String	c8b8f1baf5ef4c7bb2	关联内容id
eventType	Integer	1	任务类型（0.课件；1.课程；2.考试；3.报名；4.问卷；5.证书；6.作业；7.培训班；8.考勤；9.考核；10.AI陪练；11.直播；12.练习）
credit	Number	10	任务积分
studyDuration	Integer	2700	课件或课程学习时长（秒），仅部分任务类型返回
attendanceCodeEnable	Integer	1	考勤任务是否开启考勤码，仅考勤任务返回
originalEventName	String	企业文化课程	原始事件名称
usingState	Integer	1	任务发布状态（1.已发布；2.未发布），仅课程、考试任务返回

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/map/periodTask/list?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9&mapId=9115

正常返回示例

JSON格式

{
    "code": "200",
    "body": [
        {
            "id": "03120f7f2b124c91a9312e419e7f6b6c",
            "name": "阶段1",
            "sortIndex": 1,
            "jsonData": {
                "maxLearnNum": 0,
                "summary": "",
                "lockDuration": 0,
                "studyDurationType": 0,
                "periodTimingType": 0,
                "titleEnable": 0,
                "titleReasonStudyDuration": 0,
                "titleReasonStudyMainRange": 0,
                "titleReasonStudyHomeworkScore": 0,
                "titleEduHide": 0
            },
            "createTime": 1775738110000,
            "mapTaskList": [
                {
                    "id": "8cb68364341011f1897aa088c230c1b0",
                    "mapId": 10180,
                    "periodId": "03120f7f2b124c91a9312e419e7f6b6c",
                    "eventName": "学习赌徒回调考试",
                    "eventId": "18081844845",
                    "eventType": 2,
                    "credit": 0,
                    "sortIndex": 1,
                    "jsonData": {
                        "finishType": 1
                    },
                    "createTime": 1775738111000,
                    "studyDuration": 0,
                    "attendanceCodeEnable": 0,
                    "originalEventName": "学习赌徒回调考试",
                    "usingState": 1
                }
            ]
        },
        {
            "id": "44239c967b4344c881154d2cd56cffbb",
            "name": "阶段2",
            "sortIndex": 2,
            "jsonData": {
                "maxLearnNum": 0,
                "summary": "",
                "lockDuration": 0,
                "studyDurationType": 0,
                "periodTimingType": 0,
                "titleEnable": 0,
                "titleReasonStudyDuration": 0,
                "titleReasonStudyMainRange": 0,
                "titleReasonStudyHomeworkScore": 0,
                "titleEduHide": 0
            },
            "createTime": 1775738110000,
            "mapTaskList": [
                {
                    "id": "8cb6fda0341011f1897aa088c230c1b0",
                    "mapId": 10180,
                    "periodId": "44239c967b4344c881154d2cd56cffbb",
                    "eventName": "开放对话0626",
                    "eventId": "a6e334e3852244b8b7dac9c7ee5b6659",
                    "eventType": 10,
                    "credit": 0,
                    "sortIndex": 2,
                    "jsonData": {},
                    "createTime": 1775738111000,
                    "studyDuration": 0,
                    "attendanceCodeEnable": 0
                },
                {
                    "id": "8cb705b1341011f1897aa088c230c1b0",
                    "mapId": 10180,
                    "periodId": "44239c967b4344c881154d2cd56cffbb",
                    "eventName": "水浒说书人",
                    "eventId": "92c8c4133af6496297b41ce13d8d5930",
                    "eventType": 10,
                    "credit": 0,
                    "sortIndex": 3,
                    "jsonData": {},
                    "createTime": 1775738111000,
                    "studyDuration": 0,
                    "attendanceCodeEnable": 0
                }
            ]
        }
    ]
}

# 学习地图学员学习情况

# 功能说明

分页查询指定学习地图下学员的学习情况，数据口径与管理端 进度跟踪 - 按学员查看 列表一致，返回范围与签名管理员的数据权限范围一致。

# 调用说明

地址：

https://api2.qingsuyun.com/site/api/openApi/map/userAnalysis

方式：post

请求头：

Content-Type: application/json

factoryCode、sign 放在 URL 参数中，业务参数使用 JSON 请求体。

# 请求参数

名称	类型	是否必选	示例值	描述
factoryCode	String	是	123456	组织编号
sign	String	是	eyJhbGciOiJIUzI1NiJ9	签名
mapId	Integer	是	9115	学习地图id
pageNum	Integer	是	1	请求页码，必须大于0
pageSize	Integer	是	10	每页条数，必须大于0且不超过1000
userIds	String[]	否	["8d34db5339c64c54b3c7e2"]	学员id数组，多个id命中任一即可；最多100个，与其他筛选条件同时生效
nickname	String	否	张三	姓名或账号模糊搜索
deptPaths	String[]	否	["研发部/平台组"]	组织架构路径数组，任一匹配且按前缀匹配
finished	Integer	否	1	完成状态：0.未完成；1.已完成；2.逾期；3.未开始；4.逾期完成
userState	Integer	否	1	账号状态：1.在职；2.待审核；3.离职
tagIds	String[]	否	["标签id1","标签id2"]	成员标签id，多个标签需同时满足
mapUserTagIds	String[]	否	["地图标签id1"]	学习地图标签id，命中任一即可
showAll	Integer	否	0	是否包含曾练习过但当前不在邀请范围内的学员：0.否；1.是；默认0

# 返回数据

名称	类型	示例值	描述
code	String	200	状态码，详见说明
body	Object	如下字段	分页数据
pageNum	Integer	1	请求页码
pageSize	Integer	10	每页条数
nextPage	Integer	0	下一页页码，0表示没有下一页
total	Integer	26	总条数
pages	Integer	3	总页数
size	Integer	10	当前页的记录数
isFirstPage	Boolean	true	是否第一页
isLastPage	Boolean	false	是否最后一页
list	Array	如下字段	学员学习情况列表
userId	String	8d34db5339c64c54b	学员id
userCode	String	zsm1	账号
nickName	String	张三	姓名
userState	Integer	1	账号状态：0/1.在职；2.待审核；3.离职
memberTagNames	String	标签A,标签B	成员标签名称，逗号分隔；无标签时为null
deptName	String	研发部	组织架构名称，多个部门用分号分隔；无部门时为null
finishedMustTaskNum	Integer	3	已完成必修任务数
mustTaskNum	Integer	5	必修任务总数
finishedSelectTaskNum	Integer	1	已完成选修任务数
selectTaskNum	Integer	2	选修任务总数
studyDuration	Integer	3600	学习时长，单位：秒
gainCredit	Number	12.5	累积获得积分
gainMustCredit	Number	8	必修累积获得积分
gainSelectCredit	Number	4.5	选修累积获得积分
finished	Integer	4	完成状态：0.未完成；1.已完成；2.逾期；3.未开始；4.逾期完成
finishedTime	Date	1775738111000	学习地图完成时间（时间戳）；地图未完成时为null
studyStartTime	Date	1775730000000	开始学习时间（时间戳）；未开始时为null
scheduledEndTime	Date	1778332111000	计划结束时间（时间戳，含延期）；不限制时间时为null
rankNo	Integer	2	排名；未完成时为null
lastLearnTime	Date	1775738111000	最近学习时间（时间戳）；未学习时为null
sourceType	Integer	10	来源类型：10.人才发展地图；其他值表示学习地图来源；无学习记录时为null
postpone	Integer	1	延期天数
needManagerSign	Integer	1	是否需要管理员签名：0.否；1.是
mapUserTagName	String	重点学员	学习地图标签名称；无标签时为null
taskList	Array	如下字段	学员逐任务完成情况，按阶段、任务顺序排列，与「学习地图阶段任务列表」的任务顺序一致；地图无任务时为空数组
taskList.taskId	String	8cb68364341011f1897aa088c230c1b0	学习任务id，与「学习地图阶段任务列表」接口的 mapTaskList[].id 对应
taskList.eventId	String	18081844845	任务对应的事件id（课程id、考试id、问卷id等业务对象id）
taskList.eventType	Integer	2	事件类型：0.课件；1.课程；2.考试；3.报名；4.问卷；5.证书；6.作业；7.培训班；8.考勤；9.考核；10.AI陪练；11.直播；12.练习
taskList.finished	Integer	1	任务完成状态：0.未完成（含未开始、已开始未完成）；1.已完成；2.待重学
taskList.startTime	Date	1775730000000	任务开始时间（时间戳）；未开始或没有任务记录时为null
taskList.finishedTime	Date	1775738111000	任务完成时间（时间戳）；未完成时为null

任务状态判读：finished=1 已完成；finished=2 待重学（管理员重置了该任务）；finished=0 且 startTime=null 未开始；finished=0 且 startTime 有值已开始未完成。

错误提示：

pageNum、pageSize 缺失或不大于0时返回 60103。
pageSize 超过1000时返回 60107。
userIds 超过100个时返回 60108（数组超过长度限制！）。
mapId 缺失或非法时返回 学习地图id必选。
学习地图不存在时返回 学习地图不存在。

# 示例

请求示例

https://api2.qingsuyun.com/site/api/openApi/map/userAnalysis?factoryCode=123456&sign=eyJhbGciOiJIUzI1NiJ9

请求体

{
    "mapId": 9115,
    "userIds": ["8d34db5339c64c54b3c7e2"],
    "pageNum": 1,
    "pageSize": 10,
    "finished": 4,
    "userState": 1,
    "showAll": 0
}

正常返回示例

JSON格式

{
    "code": "200",
    "body": {
        "pageNum": 1,
        "pageSize": 10,
        "nextPage": 0,
        "total": 1,
        "pages": 1,
        "list": [
            {
                "userId": "8d34db5339c64c54b3c7e2",
                "userCode": "zsm1",
                "nickName": "张三",
                "userState": 1,
                "memberTagNames": "标签A,标签B",
                "deptName": "研发部",
                "finishedMustTaskNum": 3,
                "mustTaskNum": 5,
                "finishedSelectTaskNum": 1,
                "selectTaskNum": 2,
                "studyDuration": 3600,
                "gainCredit": 12.5,
                "gainMustCredit": 8,
                "gainSelectCredit": 4.5,
                "finished": 4,
                "finishedTime": 1775738111000,
                "studyStartTime": 1775730000000,
                "scheduledEndTime": 1778332111000,
                "rankNo": 2,
                "lastLearnTime": 1775738111000,
                "sourceType": 10,
                "postpone": 1,
                "needManagerSign": 1,
                "mapUserTagName": "重点学员",
                "taskList": [
                    {
                        "taskId": "8cb68364341011f1897aa088c230c1b0",
                        "eventId": "18081844845",
                        "eventType": 2,
                        "finished": 1,
                        "startTime": 1775730000000,
                        "finishedTime": 1775738111000
                    },
                    {
                        "taskId": "8cb6fda0341011f1897aa088c230c1b0",
                        "eventId": "a6e334e3852244b8b7dac9c7ee5b6659",
                        "eventType": 10,
                        "finished": 0,
                        "startTime": null,
                        "finishedTime": null
                    }
                ]
            }
        ],
        "isLastPage": true,
        "size": 1,
        "isFirstPage": true
    }
}

← 线下培训事件回调 →