训练方案管理

训练方案列表: /trainPrograms GET

请求参数

参数名 示列值 类型 必须 说明 默认值
page 1 number 否 当前页数 1
pageSize 10 number 否 每页条数 10
sort -createdAt string 否 排序。多个排序字段用,号隔开。sort=-a,b
expand 'trainProgramTasks' string 否 获取指定子资源数据: 'trainProgramCategory,creator,trainProgramTasks,organizations'。organizations 为入库机构列表(返回 id,name)
attributes ["id", "name"] array 否 本资源的字段。不定义该字段时返回所有字段；空数组不返回字段
name 认知训练方案 string 否 训练方案名称(模糊搜索)
categoryId 1 number 否 训练方案分类id
status 1 number 否 状态:(0:禁用,1:启用)
submitStatus 1 number 否 提交状态:(0:未提交,1:已提交)

返回参数

参数名 示列值 说明
page 1 当前页数
pageSize 10 每页条数
limit 10 同 pageSize
offset 2 起始条数
total 3231 符合条件的总数量
items [{},{}] 返回数据项(具体字段看训练方案信息)
参数名 示列值 说明
id 1 id
organizationId 1 机构id(0:超管创建)
name 认知训练方案 训练方案名称
categoryId 1 训练方案分类id
trainCount 20 训练次数
singleTrainTime 600 单次训练时长(秒)
thumbnail https://x 缩略图
description 方案描述 方案描述
status 1 状态:(0:禁用,1:启用)
submitStatus 1 提交状态:(0:未提交,1:已提交)
reviewMode 1 审批模式:(0:无需审批,1:需审批)
creatorId 1 创建人id
createdAt 1650160322 创建时间
updatedAt 1650160322 更新时间
trainProgramCategory {} 扩展字段：训练方案分类信息
creator {} 扩展字段：创建人信息
trainProgramTasks [{},{}] 扩展字段：方案任务列表(任务信息)

返回示列

HTTP/1.1 200 OK
{
    "items": [
    {
      "id": 1,
      "name": "认知训练方案",
      "categoryId": 1,
      "status": 1,
      "submitStatus": 1,
      "createdAt": 1650160322,
      "updatedAt": 1650160322,
      "trainProgramTasks": [
        { "id": 1, "name": "舒尔特方格", "resourceId": 10, "index": 1 }
      ]
    },
  ],
  "page": 1,
  "pageSize": 10,
  "limit": 10,
  "offset": 2,
  "total": 15
}

所有训练方案: /listAll/trainPrograms GET

请求参数

参数名 示列值 类型 必须 说明
expand 'trainProgramTasks' string 否 获取指定子资源数据: 'trainProgramCategory,creator,trainProgramTasks'
attributes ["id", "name"] array 否 本资源的字段。不定义该字段时返回所有字段
name 认知训练方案 string 否 训练方案名称(模糊搜索)
categoryId 1 number 否 训练方案分类id
status 1 number 否 状态:(0:禁用,1:启用)
submitStatus 1 number 否 提交状态:(0:未提交,1:已提交)

返回示列

HTTP/1.1 200 OK
[
  { "id": 1, "name": "认知训练方案", "status": 1 }
]

训练方案详情: /trainPrograms/:id GET

请求参数

参数名 示列值 类型 必须 说明
id 1 number 是 id
expand 'trainProgramTasks' string 否 获取指定子资源数据: 'trainProgramCategory,creator,trainProgramTasks,organizations'。organizations 为入库机构列表(返回 id,name)
attributes ["id", "name"] array 否 本资源的字段。不定义该字段时返回所有字段

返回结果: 训练方案信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "认知训练方案",
  "categoryId": 1,
  "status": 1,
  "submitStatus": 1,
  "trainProgramTasks": [
    { "id": 1, "name": "舒尔特方格", "resourceId": 10, "index": 1 }
  ],
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

新建训练方案: /trainPrograms POST

请求参数

参数名 示列值 类型 必须 说明 默认值
name 认知训练方案 string 是 训练方案名称
categoryId 1 number 是 训练方案分类id
trainCount 20 number 否 训练次数
singleTrainTime 600 number 否 单次训练时长(秒)
thumbnail https://x string 否 缩略图
description 方案描述 string 否 方案描述
status 1 number 否 状态:(0:禁用,1:启用)
submitStatus 1 number 否 提交状态:(0:未提交,1:已提交)
reviewMode 1 number 否 审批模式:(0:无需审批,1:需审批)
tasks [{},{}] object[] 否 方案任务列表(任务信息)
参数名 示列值 类型 必须 说明 默认值
name 任务名称 string 否 任务名称
index 1 number 是 任务排序
resourceId 10 number 是 训练内容id
trainDuration 300 number 否 建议训练时长(秒)
trainCount 5 number 否 建议训练次数

返回结果: 训练方案信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "认知训练方案",
  "status": 1,
  "submitStatus": 1,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

编辑训练方案: /trainPrograms/:id PUT

请求参数

参数名 示列值 类型 必须 说明
id 1 number 是 id
name 认知训练方案 string 是 训练方案名称
categoryId 1 number 是 训练方案分类id
trainCount 20 number 否 训练次数
singleTrainTime 600 number 否 单次训练时长(秒)
thumbnail https://x string 否 缩略图
description 方案描述 string 否 方案描述
status 1 number 否 状态:(0:禁用,1:启用)
submitStatus 1 number 否 提交状态:(0:未提交,1:已提交)
reviewMode 1 number 否 审批模式:(0:无需审批,1:需审批)
tasks [{},{}] object[] 否 方案任务列表

返回结果: 训练方案信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "认知训练方案",
  "status": 1,
  "submitStatus": 1,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

修改训练方案状态: /trainPrograms/:id/status PUT

请求参数

参数名 示列值 类型 必须 说明
id 1 number 是 训练方案 id
status 1 number 是 状态:(0:禁用,1:启用)

返回结果: 训练方案信息

返回示列

HTTP/1.1 200 OK
{
  "id": 1,
  "name": "认知训练方案",
  "status": 1,
  "createdAt": 1650160322,
  "updatedAt": 1650160322,
}

删除训练方案: /trainPrograms/:id DELETE

请求参数

参数名 示列值 类型 必须 说明
id 1 number 是 训练方案 id

返回示列

HTTP/1.1 200

名称是否重复: /isExist/trainPrograms GET

请求参数

参数名 示列值 类型 必须 说明
id 1 number 否 方案id
name 认知训练方案 string 是 名称

返回示列

HTTP/1.1 200 OK
{
  "isExist": true,
}

训练方案入库: librarySetting/trainPrograms POST

请求参数

参数名 示列值 类型 必须 说明
ids [1] array Y 训练方案 id 数组
orgIds [1,2] array Y 组织 id 数组
bulk true boolean 是否是批量入库(true:是)

返回示列

HTTP/1.1 200