获取点检设置记录详情
路径 | /industry/spotcheck/setup/get |
版本号 | 1.0.0 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
setupId | Long | 否 | 1 | 点检设置ID,setupId/equipDapId/snCode三个参数至少请填一个 |
equipDapId | Long | 否 | 123 | 生产设备主数据ID,setupId/equipDapId/snCode三个参数至少请填一个 |
corpId | String | 否 | CorpID是企业在钉钉中的标识,每个企业拥有唯一的CorpID | |
userId | String | 否 | 员工在当前企业内的唯一标识 | |
source | String | 否 | DINGDING | 来源,DINGDING或者SAAS |
snCode | String | 否 | 设备SN码,setupId/equipDapId/snCode三个参数至少请填一个 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
点检设置记录详情 |
|
setupId | Long |
点检设置记录ID |
|
equipDapId | Long |
生产设备主数据ID |
|
equipName | String |
生产设备名称 |
|
equipTypeDapId | Long |
设备类型主数据ID |
|
equipTypeName | String |
设备类型名称 |
|
equipModelDapId | Long |
设备型号主数据ID |
|
equipModelName | String |
设备型号名称 |
|
cycle | Int |
点检周期 |
|
cycleUnit | Int |
点检周期单位,从0-4分别代表(日/周/月/季/年) |
|
gmtInit | String |
点检初始化时间,格式为yyyy-MM-dd HH:mm:ss |
|
location | String |
设备位置 |
|
snCode | String |
设备SN码 |
|
owners | JSON |
点检责任人列表 |
|
ownerUserId | String |
责任人用户ID |
|
ownerUserName | String |
责任人用户名称 |
|
source | String |
责任人来源,DINGDING或SAAS |
|
items | JSON |
点检设置项目列表 |
|
setupItemId | Long |
点检设置项目ID |
|
setupItemName | String |
点检设置项目名称 |
|
checkMethod | String |
点检方法 |
|
checkStandard | String |
点检标准 |
|
timeConsuming | Int |
点检耗时(分钟) |
|
remark | String |
点检设置项目备注 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.0"
},
"params":{
"setupId":1,
"equipDapId":123,
"corpId": "value2",
"userId": "value3",
"source": "DINGDING",
"snCode": "value5"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"setupId": 1,
"equipDapId": 1,
"equipDapName": "是台空调",
"equipTypeDapId": 2,
"equipTypeName": "空调",
"equipModelDapId": 2,
"equipModelName": "格力",
"cycle": 1,
"cycleUnit": 1,
"gmtInit": "2020-01-01 00:00:00",
"location": "二楼",
"snCode": "12121abb232",
"owners": [{
"ownerUserId": "xxx",
"ownerUserName": "张三",
"source": "DINGDING"
}],
"items": [{
"setupItemId": 1,
"setupItemName": "测温度",
"checkMethod": "用温度计测量",
"checkStandard": "超过80度异常",
"timeConsuming": 10,
"remark": "备注"
}]
}
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |
200 | 107520 | alarm id is not exist | 报警id不存在 |
200 | 107521 | alarm title should not be empty | 报警title不允许为空 |
200 | 107522 | alarm content should not be empty | 报警内容不允许为空 |
200 | 107523 | alarm level error | 报警级别错误,只能为0,1,2 |
200 | 107524 | rule bind alarm definition fail | 规则关联报警定义失败 |
200 | 107525 | alarm receiver type error | 报警接收范围的类型错误,只能为role/organization/user |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 500 | server error. | 系统错误 |
200 | 500 | sever error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 460 | request parameter error. | 请求参数错误 |
200 | 500 | server error. | 系统错误 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 403 | request forbidden. | 请求被禁止 |
200 | 500 | server error. | 系统错误 |
200 | 460 | request parameter error. | 请求参数错误 |