1. 任务模板API

API列表

编号 API名称 路径 版本
1.0 分页查询 /v1/quality/taskTemplate/page 1.0
1.1 新增和修改任务模板 /v1/quality/taskTemplate/update 1.0
1.2 任务模板-指标分页列表 调用指标列表(/v1/quality/checkItem/page) 1.0
1.4 模板明细 /v1/quality/taskTemplate/get/{id} 1.0
1.5 模板列表 /v1/quality/taskTemplate/list/all 1.0
1.6 批量删除 /v1/quality/taskTemplate/removes 1.0

1.0: 分页查询(可以做模糊查询)

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/quality/taskTemplate/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageNo body int y 页码
pageSize body int y 一页多少条记录
name body String N 模板名称
checkType body int N 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型）
checkCategory body int N 专业类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值

请求Body描述(非Form表单数据)

{
    pageNo:1,
    pageSize:10,
    deviceStatus: [1, 2, 3],
  "query": {
    "name": {
      "$like": "计划"
    },
    checkType:2,
    checkCategory:-1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
pageNo data int 是 第几页
pageSize data int 是 一页多少条记录
total data int 是 一共多少条记录
records data JSONArray 是 记录集合
id records int 是 主键
name records STRING 是 任务模板名称
checkType records int 是 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型）
checkCategory records int 是 检查类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值
checkCategoryName records String 是 检查类别:对应的名称
orgId records String 是 组织id，用于做租户内数据隔离
orgCode records String 是 组织code，用于做租户内数据隔离，云邻org_code为null
createTime records String 是 创建时间
createBy records String 是 创建人姓名
updateBy records String 是 更新人姓名
createByid records String 是 创建人id
updateById records String 是 更新人id
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
    page:2,
    size:10,
    total:200,
    records:[
        {
            id:11,
            name:"模板名称xxx",
            checkType:1,
            checkCategory:1,
            orgId:12321,    
            orgCode:'12121',
            createBy:'张三',
            createTime:"2020-12-8",
        }
]}
}

1.1: 新增和修改任务模板

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/quality/taskTemplate/update

方法：POST

请求参数

名称 位置 类型 必填 描述
name body String Y 模板名称
checkType body int Y 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型）
checkCategory body int Y 专业类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值
checkItemIds body array Y 检对应检查指标id集合

请求Body描述(非Form表单数据)

{
  name:"xx名称",
  checkType:“1”,
  checkCategory:"2",
  spacePosCode:'11011011010101010122',
  orgId : "123",
  orgCode:"456",
tenantId:'123',
checkItemIds:[1,2,3,53,3]

}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

1.4: 任务模板明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/quality/taskTemplate/get/{id}

方法：GET

请求参数

名称 位置 类型 必填 描述
id url int y 主键id

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
id data int y 设备id
name body String Y 模板名称
checkType body int Y 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型）
checkCategory body int Y 专业类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值
checkItemIds body array Y 检查指标id
返回结果示例
{
  code:200,
  message:"success",
  data:{
        id:11,
  checkType:“1”,
  checkCategory:"2",
  spacePosCode:'11011011010101010122',
  orgId : "123",
  orgCode:"456",

  }
}

1.5: 模板列表

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/quality/taskTemplate/list/all

方法：POST

请求参数

请求Body描述(非Form表单数据)

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
pageNo data int 是 第几页
pageSize data int 是 一页多少条记录
total data int 是 一共多少条记录
records data JSONArray 是 记录集合
categoryFirstNode records STRING 是 业态
categorySecondNode records STRING 否 专业类别
categoryThirdNode records STRING 否 子类别
categoryFourthNode records STRING 否 子项
checkStandard records STRING 是 检查标准
checkMethod records STRING 是 检查方法
scoreStandard records STRING 是 评分标准
imageUrls records STRING 是 图片地址，多个图片用,分割
totalScore records STRING 是 该检查项总分数
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
    page:2,
    size:10,
    total:200,
    records:[
        {
             categoryFirstNode:"住宅",
            categorySecondNode:"专业类别",
            categoryThirdNode:"子类别",
            categoryFourthNode:"子项",

            checkStandard: "检查标准1",
            checkMethod:  "检查方法1",
            scoreStandard:"评分标准1",
            imageUrls: "图片地址，多个图片用,分割1",
            totalScore:100

        }
]}
}

1.6: 批量删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/quality/taskTemplate/removes

方法：POST

请求参数

名称 位置 类型 必填 描述
ids body array y 模板主键id集合

请求Body描述(非Form表单数据)

{  
    ids:[1,2,3]
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
返回结果示例
{
  "code": "200",
  "message": "success",
  "data": {
  }
}

results matching ""

    No results matching ""