1. 检查指标API
API列表
编号 | API名称 | 路径 | 版本 |
---|---|---|---|
1.0 | 分页查询 | /v1/quality/checkItem/page | 1.0 |
1.1 | 新增和修改指标 | /v1/quality/checkItem/update | 1.0 |
1.2 | 指标查询详情 | /v1/quality/checkItem/get/{id} | 1.0 |
1.3 | 指标列表 | /v1/quality/checkItem/list/all | 1.0 |
1.4 | 批量删除检查指标 | /v1/quality/checkItem/removes | 1.0 |
1.5 | 删除单个检查 | /v1/quality/checkItem/remove/{id} | 1.0 |
1.0: 分页查询
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/quality/checkItem/page
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
pageNo | body | int | y | 页码 |
pageSize | body | int | y | 一页多少条记录 |
id | body | long | N | 选择节点的id |
checkStandard | body | string | N | 检查标准 |
请求Body描述(非Form表单数据)
{"pageNo":1,"pageSize":10,"categoryCode":"100000003","checkStandard": "你好"}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 | |
---|---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识200:正常返回 | |
message | 顶层 | STRING | 是 | 响应消息文本 | |
data | 顶层 | JSONObject | 是 | 响应数据对象 | |
pageList | data | JSONObject | 是 | ||
current | pagenList | int | 是 | 第几页 | |
size | pagenList | int | 是 | 一页多少条记录 | |
total | pagenList | int | 是 | 一共多少条记录 | |
records | pagenList | JSONArray | 是 | 记录集合 | |
id | records | int | 是 | 主键 | |
categoryFirstNodeId | records | Long | 是 | 专业类别-业态id | |
categorySecondNodeId | records | Long | 否 | 上专业类别-专业类别的id | |
categoryThirdNodeId | records | Long | 否 | 专业类别-子类别的id | |
categoryFourthNodeId | records | Long | 否 | 专业类别-子项的id | |
checkStandard | records | String | 是 | 检查标准 | |
checkMethod | records | String | 是 | 检查方法 | |
scoreStandard | records | String | 是 | 评分标准 | |
imageUrls | records | String | 是 | 图片地址,多个图片用,分割 | |
totalScore | records | Float | 是 | 该检查项总分数 | |
isRefered | records | int | 是 | 1(被引用),0(没有引用) | |
categoryCode | records | String | 是 | 专业目录分类全路径code | |
orgId | records | String | 是 | 组织id,用于做租户内数据隔离 | |
orgCode | records | String | 是 | 组织code,用于做租户内数据隔离,云邻org_code为null | |
tenantId | records | String | 是 | 系统多租户id 数据来源于主数据库租户表的组件id,用于做多租户间数据隔离;为null时代表的是系统内置的分类 | |
updateTime | records | String | 是 | 更新时间 | |
createBy | records | String | 是 | 创建人姓名 | |
updateBy | records | String | 是 | 更新人姓名 | |
createByid | records | String | 是 | 创建人id | |
updateById | records | String | 是 | 更新人id | |
createTime | records | String | 是 | 创建时间 | |
firstNodeName | records | String | 是 | 专业类别-业态名称 | |
secondNodeName | records | String | 否 | 上专业类别-专业类别的名称 | |
thirdNodeName | records | String | 否 | 专业类别-子类别的名称 | |
fourthNodeName | records | String | 否 | 专业类别-子项的名称 |
返回结果示例
{
"code": 200,
"data": {
"pageList": {
"records": [
{
"id": 12,
"orgId": "88291",
"orgCode": "100000345",
"tenantId": "1",
"updateBy": null,
"updateTime": "2021-11-04T06:45:37.000+00:00",
"createBy": "品质测试1",
"createTime": "2021-11-04T06:05:49.000+00:00",
"operatorName": null,
"categoryFirstNodeId": 76,
"categorySecondNodeId": 84,
"categoryThirdNodeId": 85,
"categoryFourthNodeId": null,
"firstNodeName": "测试修改2",
"secondNodeName": "测试14",
"thirdNodeName": "测试15",
"fourthNodeName": null,
"checkStandard": "测试指标添加2",
"checkMethod": "测试指标添加1",
"scoreStandard": "测试指标添加3",
"imageUrls": null,
"totalScore": 60.0,
"isDeleted": null,
"infoId": null,
"categoryCode": "100000003100000000100000000",
"isRefered": 1,
"ids": null,
"detailsName": null
}
],
"total": 2,
"size": 10,
"current": 1,
"orders": [],
"searchCount": true,
"pages": 1
}
},
"message": "成功"
}
1.1: 新增和修改指标(添加和修改看是否有主键id)
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/quality/checkItem/update
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
checkMethod | body | String | Y | 检查方法 |
checkStandard | body | String | Y | 检查标准 |
scoreStandard | body | String | Y | 评分标准 |
infoId | body | int | Y | 专业目录的末节ID |
totalScore | body | Float | Y | 该检查项总分数 |
id | body | long | n | 主键id,添加时没有值,修改时带上当前id |
imageUrls | records | String | n | 图片地址,多个图片用,分割 |
请求Body描述(非Form表单数据)
{
"checkMethod": "测试指标添加1",
"checkStandard": "测试指标添加2",
"scoreStandard": "测试指标添加3",
"infoId": 84,
"totalScore": 60,
"id":1
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"data": {
"result": {
"id": 12,
"orgId": "88291",
"orgCode": "100000345",
"tenantId": "1",
"updateBy": null,
"updateTime": null,
"createBy": "品质测试1",
"createTime": "2021-11-04T06:05:49.420+00:00",
"categoryFirstNodeId": 76,
"categorySecondNodeId": 84,
"categoryThirdNodeId": 85,
"categoryFourthNodeId": null,
"checkStandard": "测试指标添加2",
"checkMethod": "测试指标添加1",
"scoreStandard": "测试指标添加3",
"imageUrls": null,
"totalScore": 60.0,
"isDeleted": null,
"infoId": 85,
"categoryCode": "100000003100000000100000000",
"isRefered": null,
"ids": null,
"detailsName": null
}
},
"message": "成功"
}
1.2: 指标查询详情
描述
请求信息
HTTP协议:HTTP,HTTPS
uri: /v1/quality/checkItem/get/{id}
方法:GET
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | URL | int | y | 主键 |
请求Body描述(非Form表单数据)
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
data | 顶层 | JSONObject | 是 | 响应数据对象 |
records | data | JSONArray | 是 | 记录集合 | |
---|---|---|---|---|---|
id | records | int | 是 | 主键 | |
categoryFirstNodeId | records | Long | 是 | 专业类别-业态id | |
categorySecondNodeId | records | Long | 否 | 上专业类别-专业类别的id | |
categoryThirdNodeId | records | Long | 否 | 专业类别-子类别的id | |
categoryFourthNodeId | records | Long | 否 | 专业类别-子项的id | |
checkStandard | records | String | 是 | 检查标准 | |
checkMethod | records | String | 是 | 检查方法 | |
scoreStandard | records | String | 是 | 评分标准 | |
imageUrls | records | String | 是 | 图片地址,多个图片用,分割 | |
totalScore | records | Float | 是 | 该检查项总分数 | |
isRefered | records | int | 是 | 1(被引用),0(没有引用) | |
categoryCode | records | String | 是 | 专业目录分类全路径code | |
orgId | records | String | 是 | 组织id,用于做租户内数据隔离 | |
orgCode | records | String | 是 | 组织code,用于做租户内数据隔离,云邻org_code为null | |
tenantId | records | String | 是 | 系统多租户id 数据来源于主数据库租户表的组件id,用于做多租户间数据隔离;为null时代表的是系统内置的分类 | |
updateTime | records | String | 是 | 更新时间 | |
createBy | records | String | 是 | 创建人姓名 | |
updateBy | records | String | 是 | 更新人姓名 | |
createByid | records | String | 是 | 创建人id | |
updateById | records | String | 是 | 更新人id | |
createTime | records | String | 是 | 创建时间 | |
firstNodeName | records | String | 是 | 专业类别-业态名称 | |
secondNodeName | records | String | 是 | 上专业类别-专业类别的名称 | |
thirdNodeName | records | String | 是 | 专业类别-子类别的名称 | |
fourthNodeName | records | String | 是 | 专业类别-子项的名称 |
返回结果示例
{
"code": 200,
"data": {
"result": {
"id": 10,
"orgId": "88291",
"orgCode": "100000345",
"tenantId": "1",
"updateBy": null,
"updateTime": "2021-11-04T06:46:52.000+00:00",
"createBy": "品质测试1",
"createTime": "2021-11-04T06:05:24.000+00:00",
"categoryFirstNodeId": 82,
"categorySecondNodeId": null,
"categoryThirdNodeId": null,
"categoryFourthNodeId": null,
"checkStandard": "测试指标添加2",
"checkMethod": "测试指标添加1",
"scoreStandard": "测试指标添加3",
"imageUrls": null,
"totalScore": 100.0,
"isDeleted": 0,
"infoId": null,
"categoryCode": "100000008",
"isRefered": 0,
"ids": null,
"detailsName": "测试13"
}
},
"message": "成功"
}
1.3: 指标列表
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/quality/checkItem/list/all
方法:POST
请求参数
无
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 | |
---|---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识200:正常返回 | |
message | 顶层 | STRING | 是 | 响应消息文本 | |
data | 顶层 | JSONObject | 是 | 响应数据对象 | |
records | data | JSONArray | 是 | 记录集合 | |
id | records | int | 是 | 主键 | |
categoryFirstNodeId | records | Long | 是 | 专业类别-业态id | |
categorySecondNodeId | records | Long | 否 | 上专业类别-专业类别的id | |
categoryThirdNodeId | records | Long | 否 | 专业类别-子类别的id | |
categoryFourthNodeId | records | Long | 否 | 专业类别-子项的id | |
checkStandard | records | String | 是 | 检查标准 | |
checkMethod | records | String | 是 | 检查方法 | |
scoreStandard | records | String | 是 | 评分标准 | |
imageUrls | records | String | 是 | 图片地址,多个图片用,分割 | |
totalScore | records | Float | 是 | 该检查项总分数 | |
isRefered | records | int | 是 | 1(被引用),0(没有引用) | |
categoryCode | records | String | 是 | 专业目录分类全路径code | |
orgId | records | String | 是 | 组织id,用于做租户内数据隔离 | |
orgCode | records | String | 是 | 组织code,用于做租户内数据隔离,云邻org_code为null | |
tenantId | records | String | 是 | 系统多租户id 数据来源于主数据库租户表的组件id,用于做多租户间数据隔离;为null时代表的是系统内置的分类 | |
updateTime | records | String | 是 | 更新时间 | |
createBy | records | String | 是 | 创建人姓名 | |
updateBy | records | String | 是 | 更新人姓名 | |
createByid | records | String | 是 | 创建人id | |
updateById | records | String | 是 | 更新人id | |
createTime | records | String | 是 | 创建时间 | |
firstNodeName | records | String | 是 | 专业类别-业态名称 | |
secondNodeName | records | String | 是 | 上专业类别-专业类别的名称 | |
thirdNodeName | records | String | 是 | 专业类别-子类别的名称 | |
fourthNodeName | records | String | 是 | 专业类别-子项的名称 |
返回结果示例
{
"code": 200,
"data": {
"records": [
{
"checkType": "1",
"checkContent": null,
"checkCategory": -1,
"updateTime": "2021-11-04T08:05:34.000+00:00",
"isRefered": 0,
"orgId": "88291",
"createBy": "品质测试1",
"createTime": "2021-11-04T06:45:38.000+00:00",
"updateBy": null,
"orgCode": "100000345",
"name": "模板添加测试2",
"tenantId": "1",
"checkItemIds": null,
"ids": null,
"id": 7
}
]
},
"message": "success"
}
1.4: 批量删除检查指标
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/quality/checkItem/removes
方法:POST
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
ids | body | JSONArray | y | 主键 |
请求Body描述(非Form表单数据)
{
ids:[1,2,3]
}
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
返回结果示例
{
"code": "200",
"message": "成功"
}
1.5: 删除单个检查
描述
请求信息
HTTP协议:HTTP,HTTPS
uri:/v1/quality/checkItem/remove/{id}
方法:DELETE
请求参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
id | url | int | y | 主键 |
请求Body描述(非Form表单数据)
返回信息
返回参数类型
JSON
返回参数
名称 | 位置 | 类型 | 必填 | 描述 |
---|---|---|---|---|
code | 顶层 | STRING | 是 | 响应码标识 |
message | 顶层 | STRING | 是 | 响应消息文本 |
返回结果示例
{
"code": "200",
"message": "成功"
}