1. 计划管理API

API列表

编号 API名称 路径 版本
1.0 分页查询 /v1/quality/planInstance/page 1.0
1.1 新增计划 /v1/quality/planInstance/add/batch 1.0
1.2 编辑计划 /v1/quality/planInstance/update 1.0
1.3 计划详情页 /v1/quality/planInstance/get/{id} 1.0
1.4 批量删除 /v1/quality/planInstance/remove/batch 1.0
1.5 计划明细 /quality/planInstance/item-detail/{id} 1.0
1.6 整改明细 /quality/planInstance/reform-detail/{id} 1.0
1.7 整改日志 /quality/planInstance/log-detail/{id} 1.0

1.0: 分页查询

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/quality/planInstance/page

方法：POST

请求参数

名称 位置 类型 必填 描述
pageSize body int y 一页多少条记录
pageNo body int y 第几页。从1开始
orgId body String y 业务组织id （业务组织id和小区id两个必传一个）
planName query json N 计划名称
checkType query json N 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型）
communityId query json N 项目id
beginTime query json N 开始时间
createrName query json N 创建人名称
status query json N 计划状态 枚举值： 1.未启动；2.进行中；3.已完成；4.过期未启动；5.过期未完成

请求Body描述

{
"orgId":21897,
    "pageSize": 2,
    "pageNo": 1,
    "order": {
        "create_time": "desc"
    },
    "query": {
        "communityId":{
            "$eq":"21906"
        },
        "planName": {
            "$like": "计划"
        },"checkType": {
            "$eq": "1"
        },
        "createrName":{
            "$like":"品质测试"
        },
        "status": {
            "$in": [
                1,2
            ]
        },
        "beginTime":{
            "$gte":"2021-11-04T00:00:00.000Z"
        },
        "beginTime":{
            "$lte":"2021-11-28T00:00:00.000Z"
        }
    }
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONObject 是 响应数据对象
pageNo data int 是 第几页
pageSize data int 是 一页多少条记录
total data int 是 一共多少条记录
records data JSONArray 是 记录集合
id records int 是 主键
planCode records STRING 是 计划编号
planName records STRING 是 计划名称
checkType records int 是 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型）
checkCategory records int 是 检查类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值
beginTime records String 是 计划开始时间
communityName records String 是 项目名称
adminName records String 是 执行人
createrName records String 是 创建人名称
status records int 是 任务状态 枚举值： 1.未启动；2.进行中；3.已完成；4.过期未启动；5.过期未完成
orgId records String 是 组织id，用于做租户内数据隔离
orgCode records String 是 组织code，用于做租户内数据隔离，云邻org_code为null
createBy records String 是 创建人
createTime records String 是 创建时间
checkCategoryName records String 是 专业分类名称
返回结果示例
{
    "code": 200,
    "data": {
        "total": 2,
        "pages": 1,
        "records": [
            {
                "hasPushedMessage": false,
                "flowTemplateId": null,
                "planOriginalDataLogId": 4,
                "allRectificationPassDate": null,
                "checkCategory": 71,
                "planName": "计划1-修改名",
                "operatorName": null,
                "flowInstanceId": null,
                "orgId": "88291",
                "taskTemplateId": 7,
                "updateBy": null,
                "orgCode": "100000345",
                "adminId": "32080",
                "communityName": "领贤公馆aavv",
                "beginTime": "2021-11-05T00:00:00.000+00:00",
                "id": 2,
                "communityId": "21906",
                "checkType": "1",
                "remainTime": null,
                "updateTime": "2021-11-04T12:27:16.000+00:00",
                "allRectificationCompletionDate": null,
                "createrName": "品质测试1",
                "planCode": "PL2021000011",
                "adminName": "亥亥",
                "createBy": "88293",
                "allSubmitDate": null,
                "createTime": "2021-11-04T12:10:40.000+00:00",
                "tenantId": "1",
                "ids": null,
                "originalTotalScore": null,
                "endTime": "2021-11-07T00:00:00.000+00:00",
                "originalRectificationNumber": null,
                "status": 2
            },
            {
                "hasPushedMessage": false,
                "flowTemplateId": null,
                "planOriginalDataLogId": 4,
                "allRectificationPassDate": null,
                "checkCategory": 71,
                "planName": "计划1",
                "operatorName": null,
                "flowInstanceId": null,
                "orgId": "88291",
                "taskTemplateId": 7,
                "updateBy": null,
                "orgCode": "100000345",
                "adminId": "32080",
                "communityName": "领贤公馆aavv",
                "beginTime": "2021-11-21T16:00:00.000+00:00",
                "id": 6,
                "communityId": "21906",
                "checkType": "1",
                "remainTime": null,
                "updateTime": "2021-11-04T12:10:40.000+00:00",
                "allRectificationCompletionDate": null,
                "createrName": "品质测试1",
                "planCode": "PL2021000015",
                "adminName": "亥亥",
                "createBy": "88293",
                "allSubmitDate": null,
                "createTime": "2021-11-04T12:10:40.000+00:00",
                "tenantId": "1",
                "ids": null,
                "originalTotalScore": null,
                "endTime": "2021-11-24T16:00:00.000+00:00",
                "originalRectificationNumber": null,
                "status": 1
            }
        ],
        "pageNo": 1,
        "pageSize": 10
    },
    "message": "success"
}

API调用

1.1: 新增计划

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/quality/planInstance/add/batch

方法：POST

请求参数

名称 位置 类型 必填 描述
planName body STRING 是 计划名称
checkType body int 是 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型）
checkCategory body int 是 检查类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值
frequency body String 是 周期/频率 :none(无周期)，one_day(1天)、seven_day(7天)、fourteen_day(14天)、 one_month(1个月)、one_quarter(1个季度)、half_a_year(半年)、a_year(一年)
fullCycleBeginTime body String 是 全周期开始时间
fullCycleEndTime body String 是 全周期结束时间
singleCycleExecutionDuration body integer 否
taskTemplateId body int 是 模板id
communityAndEmployees body List 是 项目id和员工id集合
community_id communityAndEmployees String 是 项目id
admin_id communityAndEmployees String 是 员工id
tokeninfo Header String 是 token信息，登陆后可以获取

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

{
    "planName":"计划1",
    "checkType":1,
    "checkCategory":71,
    "frequency":"seven_day",
    "singleCycleExecutionDuration":3,
    "fullCycleBeginTime":"2021-11-08T00:00:00.000Z",
    "fullCycleEndTime":"2021-12-08T00:00:00.000Z",
    "communityAndEmployees":[
        {"community_id":21906,"admin_id":32080},
        {"community_id":22299,"admin_id":32078}
        ],
    "taskTemplateId":7
}

返回信息

返回参数类型

JSON

返回参数

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

API调用

1.2: 编辑计划

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/quality/planInstance/update

方法：POST

请求参数

名称 位置 类型 必填 描述
id body STRING 是 计划名称
planName body STRING 否 计划名称【计划的状态为1未启动时，必填】
checkType body int 否 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型）【计划的状态为1未启动时，必填】
checkCategory body int 否 检查类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值【计划的状态为1未启动时，必填】
beginTime body String 否 计划开始时间【计划的状态为1未启动时，必填】
endTime body String 是 计划结束时间
communityId body String 否 项目id【计划的状态为1未启动时，必填】
adminId body String 否 执行人id【计划的状态为1未启动时，必填】
taskTemplateId body int 否 模板id【计划的状态为1未启动时，必填】
tokeninfo Header String 是 token信息，登陆后可以获取

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

{
    "id":2,
    "planName":"计划1-修改名2",
    "checkType":1,
    "checkCategory":71,
    "beginTime":"2021-11-06T00:00:00.000Z",
    "endTime":"2021-11-07T00:00:00.000Z",
    "communityId":"21906",
    "adminId":"32080",
    "taskTemplateId":7
}

或
{
    "id":2,
    "endTime":"2021-11-07T00:00:00.000Z"
}

返回信息

返回参数类型

JSON

返回参数

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

1.3: 计划详情页

描述

请求信息

HTTP协议：HTTP,HTTPS

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

方法：POST

请求参数

名称 位置 类型 必填 描述
id url int y 计划id

请求实例：

http://localhost:20070/v1/quality/planInstance/get/2

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 描述
id body STRING 计划id
planName body STRING 计划名称
planCode body STRING 计划编号
checkType body int 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型）
checkCategory body int 检查类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值
beginTime body String 计划开始时间
endTime body String 计划结束时间
communityId body String 项目id
communityName body String 项目名称
adminId body String 执行人id
adminName body String 执行人
createrName body String 创建人名称
status body String 任务状态 枚举值： 1.未启动；2.进行中；3.已完成；4.过期未启动；5.过期未完成
taskTemplateId body int 任务模板id
orgId body String 组织id，用于做租户内数据隔离
orgCode body String 组织code，用于做租户内数据隔离，云邻org_code为null
createTime body String 创建日期
operatorName body String 操作人名
updateTime body String 更新日期
checkCategoryName records String 专业分类名称
返回结果示例
{
    "code": 200,
    "data": {
        "hasPushedMessage": false,
        "flowTemplateId": null,
        "planOriginalDataLogId": 4,
        "allRectificationPassDate": null,
        "checkCategory": 71,
        "planName": "计划1-修改名",
        "operatorName": null,
        "flowInstanceId": null,
        "orgId": "88291",
        "taskTemplateId": 7,
        "updateBy": null,
        "orgCode": "100000345",
        "adminId": "32080",
        "communityName": "领贤公馆aavv",
        "beginTime": "2021-11-05T00:00:00.000+00:00",
        "id": 2,
        "communityId": "21906",
        "checkType": "1",
        "remainTime": null,
        "updateTime": "2021-11-04T12:27:16.000+00:00",
        "allRectificationCompletionDate": null,
        "createrName": "品质测试1",
        "planCode": "PL2021000011",
        "adminName": "亥亥",
        "createBy": "88293",
        "allSubmitDate": null,
        "createTime": "2021-11-04T12:10:40.000+00:00",
        "tenantId": "1",
        "ids": null,
        "originalTotalScore": null,
        "endTime": "2021-11-07T00:00:00.000+00:00",
        "originalRectificationNumber": null,
        "status": 2
    },
    "message": "success"
}

1.4: 批量删除

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/v1/quality/planInstance/remove/batch

方法：POST

请求参数

| 名称 | 位置 | 类型 | 必填 | 描述 | | ids | body | array | y | 模板id |

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

{
    "ids":[3,4,5]
}

返回信息

返回参数类型

JSON

返回参数

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

1.5: 检查项明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/quality/planInstance/item-detail/{id}

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 计划id

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

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONArray 是 响应数据对象
categoryFirstNode data STRING 是 业态
categorySecondNode data STRING 是 专业类别
categoryThirdNode data STRING 是 子类别
categoryFourthNode data STRING 是 子项
checkStandard data STRING 是 检查标准
checkMethod data STRING 是 检查方法
scoreStandard data STRING 是 评分标准
imageUrls data STRING 是 图片地址，多个图片用,分割
totalScore data STRING 是 该检查项总分数
返回结果示例
{
  code:200,
  message:"success",
  data:[{
            categoryFirstNode:"住宅",
            categorySecondNode:"专业类别",
            categoryThirdNode:"子类别",
            categoryFourthNode:"子项",

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

}

1.5: 计划明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/quality/planInstance/item-detail/{id}

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 计划id

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

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONArray 是 响应数据对象
categoryFirstNode data STRING 是 业态
categorySecondNode data STRING 是 专业类别
categoryThirdNode data STRING 是 子类别
categoryFourthNode data STRING 是 子项
checkStandard data STRING 是 检查标准
checkMethod data STRING 是 检查方法
scoreStandard data STRING 是 评分标准
imageUrls data STRING 是 图片地址，多个图片用,分割
totalScore data STRING 是 该检查项总分数
返回结果示例
{
  code:200,
  message:"success",
  data:[{
            categoryFirstNode:"住宅",
            categorySecondNode:"专业类别",
            categoryThirdNode:"子类别",
            categoryFourthNode:"子项",

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

}

1.6: 整改明细

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/quality/planInstance/reform-detail/{id}

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 计划id

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

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONArray 是 响应数据对象
categoryFirstNode data STRING 是 业态
categorySecondNode data STRING 是 专业类别
categoryThirdNode data STRING 是 子类别
categoryFourthNode data STRING 是 子项
checkStandard data STRING 是 检查标准
checkMethod data STRING 是 检查方法
scoreStandard data STRING 是 评分标准
imageUrls data STRING 是 图片地址，多个图片用,分割
totalScore data STRING 是 该检查项总分数
返回结果示例
{
  code:200,
  message:"success",
  data:[{
            categoryFirstNode:"住宅",
            categorySecondNode:"专业类别",
            categoryThirdNode:"子类别",
            categoryFourthNode:"子项",

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

}

1.7: 整改日志

描述

请求信息

HTTP协议：HTTP,HTTPS

uri：/quality/planInstance/reform-log/{id}

方法：POST

请求参数

名称 位置 类型 必填 描述
id body int y 检查项id

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

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 是 响应码标识200:正常返回
message 顶层 STRING 是 响应消息文本
data 顶层 JSONArray 是 响应数据对象
totalScore data STRING 是 该检查项总分数
checkResult data STRING 是 该检查项当前检查结果 枚举值 1：通过 2：不通过
deductPoints data STRING 是 该检查项扣分值
getPoints data STRING 是 该检查项得分值
rectifyExpirDate data STRING 是 整改截止日期
imageUrls data STRING 是 检查方法
remark data STRING 是 备注
resultType data STRING 是 图片地址，多个图片用,分割
adminId body String 是 执行人id
adminName body String 是 执行人
logStatus body int 是 1.正常 , 2.异常
返回结果示例
{
  code:200,
  message:"success",
  data:[{
            categoryFirstNode:"住宅",
            categorySecondNode:"专业类别",
            categoryThirdNode:"子类别",
            categoryFourthNode:"子项",

            checkStandard: "检查标准1",
            checkMethod:  "检查方法1",
            scoreStandard:"评分标准1",
            imageUrls: "图片地址，多个图片用,分割1",
            totalScore:100,
            adminName:执行人，
            logStatus:2
        }]

}

results matching ""

    No results matching ""