1. app品检API
API列表 test
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 1.0 | 列表查询 | /v1/quality/appPlan/plan-list | 1.0 |
| 1.01 | 查询计划明细 | /v1/quality/appPlan/item-list/{id} | 1.0 |
| 1.1 | 品检提交 | /v1/quality/appPlan/update-item | 1.0 |
| 1.2 | 品检整改 | /v1/quality/appPlan/reform-item | 1.0 |
| 1.3 | 品检复检 | /v1/quality/appPlan/recheck-item | 1.0 |
| 1.4 | 任务历史明细 | /v1/quality/appPlan/item-history/{id} | 1.0 |
1.0: 列表查询
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/quality/appPlan/plan-list
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| pageNo | body | int | y | 页码 |
| pageSize | body | int | y | 一页多少条记录 |
| adminId | body | String | y | 用户id |
| queryFlag | body | int | y | 1.我的任务， 2品检结果 |
| communityId | body | String | y | 小区id |
| status | body | int | n | 任务状态 枚举值： 1.未启动；2.进行中；3.已完成；4.过期未启动；5.过期未完成 |
请求Body描述(非Form表单数据)
{"adminId":"32078" , "queryFlag" :1 , "communityId": "22299"}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识200:正常返回 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
| pageNo | data | int | 是 | 第几页 |
| pageSize | data | int | 是 | 一页多少条记录 |
| total | data | int | 是 | 一共多少条记录 |
| records | data | JSONArray | 是 | 记录集合 |
| id | records | int | 是 | 计划实例id |
| planName | records | STRING | 是 | 计划名称 |
| checkType | records | int | 是 | 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型） |
| checkCategory | records | int | 是 | 检查类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值 |
| checkCategoryName | records | String | 是 | 检查类别. |
| communityName | records | String | 是 | 项目名称 |
| orgId | records | String | 是 | 组织id，用于做租户内数据隔离 |
| status | records | int | 是 | 任务状态 枚举值： 1.未启动；2.进行中；3.已完成；4.过期未启动；5.过期未完成 |
| beginTime | records | DateTime | 是 | 开始时间 |
| endTime | records | DateTime | 是 | 计划结束时间 |
| createBy | records | String | 是 | 创建人 |
| createTime | records | String | 是 | 创建时间 |
| allCount | records | int | 是 | 检查项数量 |
| completeCount | records | int | 是 | 已完成数量 |
| expCount | records | int | 是 | 异常数量 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
page:2,
size:10,
total:200,
records:[
{
"adminId": "",
"adminName": "",
"beginTime": "",
"checkCategory": 0,
"checkType": "",
"communityId": "",
"communityName": "",
"endTime": "",
"orgId": "",
"planCode": "",
"planName": "",
"remainTime": 0,
"status": 0,
"taskTemplateId": 0
}
]}
}
1.01: 计划实例明细信息
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/quality/appPlan/item-list/{id}
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | body | int | y | 计划实例id |
请求Body描述(非Form表单数据)
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 | |
|---|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识200:正常返回 | |
| message | 顶层 | STRING | 是 | 响应消息文本 | |
| data | 顶层 | JSONObject | 是 | 响应数据对象 | |
| id | data | int | 是 | 计划实例id | |
| planName | data | STRING | 是 | 计划名称 | |
| planCode | data | STRING | 是 | 计划编号 | |
| checkType | data | int | 是 | 检查类型:字典值 1.集团年度品检、2.分公司季度品检、3.项目日常品检 （待扩展其他类型） | |
| checkCategory | data | int | 是 | 检查类别:-1代表其他，其他值对应专业目录表中类型为专业类别的id值 | |
| checkCategoryName | records | String | 是 | 检查类别. | |
| communityName | data | String | 是 | 项目名称 | |
| orgId | data | String | 是 | 组织id，用于做租户内数据隔离 | |
| status | data | int | 是 | 任务状态 枚举值： 1.未启动；2.进行中；3.已完成；4.过期未启动；5.过期未完成 | |
| beginTime | data | DateTime | 是 | 开始时间 | |
| endTime | data | DateTime | 是 | 计划结束时间 | |
| adminId | data | String | 是 | 执行人id | |
| adminName | data | String | 是 | 执行人名称 | |
| items | records | JSONArray | 是 | 检查项列表 | |
| id | items | JSONArray | 是 | 检查项id | |
| checkStandard | items | JSONArray | 是 | 检查标准 | |
| checkMethod | items | JSONArray | 是 | 评分标准 | |
| adminId | data | String | 是 | 执行人id | |
| adminName | data | String | 是 | 执行人名称 | |
| deductPoints | data | String | 是 | 扣分项 | |
| currentCheckResult | items | JSONArray | 是 | 检查结果1.正常， 2，异常 | |
| remark | items | String | 否 | 备注 | |
| hisUrl | items | JSONArray | 是 | 图片url |
返回结果示例
{
"code": 200,
"data": {
"checkCategory": 71,
"planName": "计划1-jf",
"orgId": "88291",
"orgCode": "100000345",
"adminId": "32080",
"adminName": "亥亥",
"communityName": "领贤公馆aavv",
"beginTime": "2021-11-01T16:00:00.000+00:00",
"endTime": "2021-11-24T16:00:00.000+00:00",
"id": 2,
"communityId": "21906",
"checkType": "1",
"remainTime": null,
"updateTime": "2021-11-06T08:28:43.000+00:00",
"allRectificationCompletionDate": null,
"createrName": "品质测试1",
"planCode": "PL2021000015",
"tenantId": "1",
"status": 1,
"items": [
{
"id": 1,
"checkCategory": null,
"checkMethod": null,
"planName": "计划1-jf",
"checkStandard": null,
"operatorName": null,
"orgId": "",
"itemId": 2,
"updateBy": null,
"orgCode": null,
"communityName": "领贤公馆aavv",
"beginTime": "2021-11-06T00:59:56.000+00:00",
"communityId": "21906",
"checkType": "",
"planInstanceId": 2,
"firstCheckDate": "2021-11-06T08:46:06.000+00:00",
"scoreStandard": null,
"totalScore": null,
"planCode": "PL2021000015",
"adminName": "亥亥",
"categoryFirstNodeName": null,
"rectificationPassDate": null,
"tenantId": "1",
"currentCheckResult": 1,
"endTime": "2021-11-07T01:00:05.000+00:00"
}
]
},
"message": "success"
}
1.1: 品检提交
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/quality/appPlan/update-item
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | body | String | Y | 检查项id |
| planInstanceId | body | String | Y | 实例id |
| imageUrls | body | String | N | 图片url |
| remark | body | String | N | 备注 |
| checkResult | body | int | N | 检查结果 |
| adminId | body | String | Y | 执行人id |
| adminName | body | String | Y | 执行人名称 |
| deductPoints | body | String | N | 扣分 |
| rectifyExpirDate | body | Date | Y | 整改截止日期 |
请求Body描述(非Form表单数据)
{"id":1,
"imageUrls":"www.baidu.com, www.sougou.com",
"remark":"222备注",
"planInstanceId":2,
"checkResult":1,
"adminId": 1234,
"adminName": "廖杰发"
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.2: 品检整改
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/quality/appPlan/reform-item
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | body | String | Y | 检查项id |
| planInstanceId | body | String | Y | 实例id |
| imageUrls | body | String | N | 图片url |
| remark | body | String | N | 备注 |
| checkResult | body | int | N | 检查结果 |
| adminId | body | String | Y | 执行人id |
| adminName | body | String | Y | 执行人名称 |
请求Body描述(非Form表单数据)
{"id":1,
"planInstanceId":2,
"imageUrls":"www.baidu.com, www.sougou.com",
"remark":"222备注",
"adminId":"整改人id",
"adminName":"整改人"
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.3: 品检复检
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/quality/appPlan/recheck-item
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | body | String | Y | 检查项id |
| planInstanceId | body | String | Y | 实例id |
| imageUrls | body | String | N | 图片url |
| remark | body | String | N | 备注 |
| checkResult | body | int | N | 检查结果 |
| adminId | body | String | Y | 复检人id |
| adminName | body | String | Y | 复检名称 |
请求Body描述(非Form表单数据)
{"id":1,
"imageUrls":"www.baidu.com, www.sougou.com",
"remark":"222备注",
"planInstanceId":2,
"checkResult":1,
"adminId": 1234,
"adminName": "廖杰发"
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
1.4: 任务历史明细
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/v1/quality/appPlan/item-history
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| id | body | int | y | 任务id |
| adminId | body | String | Y | 执行人id |
| adminName | body | String | Y | 执行人名称 |
请求Body描述(非Form表单数据)
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识200:正常返回 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
| pageType | data | int | 是 | 1:整改. 2.复核页面 , 3.查看 |
| records | data | JSONArray | 是 | 具体的任务历史明细 |
| planInstanceId | records | Long | 是 | 计划实例的id |
| itemId | records | Long | 是 | 检查指标id |
| totalScore | records | float | 是 | 该检查项总分数 |
| checkResult | records | int | 是 | 该检查项当前检查结果 枚举值 1：通过 2：不通过 |
| deductPoints | records | float | 是 | 该检查项扣分值 |
| getPoints | records | float | 是 | 该检查项得分值 |
| rectifyExpirDate | records | Datetime | 是 | 整改截止日期 |
| imageUrls | records | String | 是 | 图片url，多个图片地址用逗号,分割 |
| remark | records | String | 是 | 备注 |
| resultType | records | int | 是 | 检查结果类型，枚举值 1:检查结果 2:整改提交 |
| adminId | records | String | 是 | 执行人id |
| adminName | records | String | 是 | 执行人名称 |
返回结果示例
{
"code": 200,
"data": {
"records": [
{
"id": 1,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:17",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 2,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注"
},
{
"id": 2,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:19",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 1,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注"
},
{
"id": 3,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:25",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 1,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注"
},
{
"id": 4,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:28",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 2,
"deductPoints": 5.0,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注"
},
{
"id": 5,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:30",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 2,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注",
"adminId": "整改人id",
"adminName": "整改人"
},
{
"id": 6,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:32",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 2,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注",
"adminId": "整改人id",
"adminName": "整改人",
"resultType": 2
},
{
"id": 7,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:35",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 1,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注",
"resultType": 1
},
{
"id": 8,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:38",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 1,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注"
},
{
"id": 12,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:40",
"createTime": "2021-11-06 16:39:12",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 1,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注",
"adminId": "1234",
"adminName": "廖杰发",
"resultType": 1
},
{
"id": 13,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:14:42",
"createTime": "2021-11-06 16:40:52",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 1,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注",
"adminId": "1234",
"adminName": "廖杰发",
"resultType": 1
},
{
"id": 15,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 11:15:03",
"createTime": "2021-11-06 16:46:24",
"planInstanceId": 10,
"itemId": 2,
"checkResult": 1,
"rectifyExpirDate": "2021-11-09 11:12:45",
"imageUrls": "https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271;https://img0.baidu.com/it/u=1327229781,3929005504&fm=253&fmt=auto&app=120&f=JPEG?w=523&h=271",
"remark": "222备注",
"adminId": "1234",
"adminName": "廖杰发",
"resultType": 1
},
{
"id": 16,
"orgId": "",
"tenantId": "1",
"updateTime": "2021-11-09 13:57:36",
"createTime": "2021-11-09 13:57:36",
"planInstanceId": 10,
"itemId": 2,
"imageUrls": "www.baidu.com, www.sougou.com",
"remark": "222备注",
"adminId": "整改人id",
"adminName": "整改人",
"resultType": 2
}
]
},
"message": "success"
}