- 2.4.1.7.14. Equipment(设备)
- 2.4.1.7.14.1. 查询Equipment列表(关注设备)
- 2.4.1.7.14.2. 查询Equipment指定记录
- 2.4.1.7.14.3. 添加Equipment
- 2.4.1.7.14.4. 编辑Equipment
- 2.4.1.7.14.5. 删除Equipment
- 2.4.1.7.14.6. 查询Equipment反向控制列表
- 2.4.1.7.14.7. 查询Equipment故障和报警列表
- 2.4.1.7.14.8. 查询Equipment服务和作业列表
- 2.4.1.7.14.9. 查询 Equipment APP显示板信息
- 2.4.1.7.14.10. 查询Equipment故障和报警挂板列表
- 2.4.1.7.14.11. 查询Equipment设备关联适配器的Fidis变量
2.4.1.7.14. Equipment(设备)
2.4.1.7.14.1. 查询Equipment列表(关注设备)
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/get_list |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| page_index | 查询页码 | Integer | 大于 0,如果为空,则默认从第一页显示 | 否 |
| page_size | 每页记录数 | Integer | 大于 0,如果为空,则默认为 20 | 否 |
| condition | 查询条件 | Json | LIKE模糊搜索条件 | 否 |
| start_time | 开始时间 | Datetime | 按创建时间搜索的开始时间和结束时间 | 否 |
| end_time | 结束时间 | Datetime | 否 | |
| is_all | 是否不分页返回(即返回所有数据) | Boolean | 1:是,0:否;如果为空,则默认0 | 否 |
condition参数:
格式
[["${key}", "${operator}", "${value}"]] 即 [["查询值", "运算符", "查询内容"
举例
[["equipment_id", "=", "1001"]]
返回参数:
|————|—————|—————|——————————-|—————|| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 || code | 返回码 | Integer | 200:成功 500:失败 | 是 || msg | 提示信息 | String | | 是 || result | 结果 | Json | | 是|| || | | | | |
返回数据举例:
{"code": 200,"msg": "查询成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": {"page_index": 1,"page_size": 20,"total_pages": 1,"total_records": 1,"data": [{"equipment_id": 1005,"equipment_name": "设备5","description": "设备5","customer_id": 1003,"equipment_sn": "1001","model": "设备5","type_id": 1001,"camera_list": "","is_group": 0,"camera_url": "http://hls.open.ys7.com/openlive/9ba56459b9ca4e78b85ebced5c365083.m3u8,https://www.baidu.com","datasheet_id": 1001,"aprus_list": [" A22018083100003 ", "A22018083100002"],"mapping_id": 1003,"gis": "","secret": "DZHR","auth_code": 1234,"equipment_image": "equipment/2018/09/Desert_VJR97.jpg","addition": [{"title ": "基本信息 ","data ": [["生产厂家 ", ""],["锅炉吨位 ", "10 吨 "],["设备尺寸 ", ""],["设备重量 ", ""],["制造日期 ", ""],["启用日期 ", ""]]}],"created": "2018-08-3018:24:19","customer_name": "test","status_code": 0,"status_name": "停止"}]}}
2.4.1.7.14.2. 查询Equipment指定记录
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/get |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_id | 设备标识 | String | 是 |
返回参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| code | 返回码 | Integer | 200:成功 500:失败 | 是 |
| msg | 提示信息 | String | 是 | |
| result | 返回结果 | Json | 是 |
返回示例:
{"code": 200,"msg": "查询成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": {"equipment_id": 1005,"equipment_name": "设备5","description": "设备5","customer_id": 1003,"equipment_sn": "1001","model": "设备5","type_id": 1001,"camera_list": "","is_group": 0,"camera_url": "http://hls.open.ys7.com/openlive/9ba56459b9ca4e78b85ebced5c365083.m3u8,https://www.baidu.com","datasheet_id": 1001,"aprus_list": [" A22018083100003 ", "A22018083100002"],"mapping_id": 1003,"gis": "","secret": "DZHR","auth_code": 1234,"equipment_image": "equipment/2018/09/Desert_VJR97.jpg","addition": [{"title ": "基本信息 ","data ": [["生产厂家 ", ""],["锅炉吨位 ", "10 吨 "],["设备尺寸 ", ""],["设备重量 ", ""],["制造日期 ", ""],["启用日期 ", ""]]}],"created": "2018-08-3018:24:19","customer_name": "test","status_code": 0,"status_name": "停止"}}
2.4.1.7.14.3. 添加Equipment
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/add |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_name | 设备名称 | String | 是 | |
| description | 描述 | Text | 否 | |
| customer_id | 客户标识 | String | 否 | |
| equipment_sn | 设备编号 | String | 否 | |
| model | 设备型号 | String | 否 | |
| datasheet_id | 设备数据表标识 | String | 否 | |
| aprus_list | 适配器列表 | String | 否 | |
| mapping_id | 设备与适配器参数映射表标识 | String | 否 | |
| statistics_id | 统计计算标识 | String | 否 | |
| gis | 设备地理信息 | String | 否 | |
| secret | 管理密码 | String | 否 | |
| auth_code | 反向控制管理密码 | String | 否 | |
| equipment_image | 设备图片路径 | String | 否 | |
| addition | 附加字段/自定义字段 | Json | 否 | |
| template | 模板/样式 | text | 否 | |
| script | 脚本 | text | 否 | |
| reference | 参考号 | String | 否 |
addition数据格式说明(json格式):
[{"title": "锅炉信息","data": [["燃料类型","天然气"],["锅炉重量","2吨"],["出厂日期","2018-03-03"]]},{"title": "能效指标信息","data": [["热效率",0.8],["燃料热值",7000],["吨汽燃料指标",0.21]]}]```json返回参数:| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 ||--------|----------|----------|---------------------|----------|| code | 返回码 | Integer | 200:成功 500:失败 | 是 || msg | 提示信息 | String | | 是 || result | 返回结果 | Json | | 是 |返回示例:```json{"code": 200,"msg": "添加成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": []}
2.4.1.7.14.4. 编辑Equipment
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/edit |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_id | 设备标识 | String | 是 | |
| equipment_name | 设备名称 | String | 否 | |
| description | 描述 | Text | 否 | |
| customer_id | 客户标识 | String | 否 | |
| equipment_sn | 设备编号 | String | 否 | |
| model | 设备型号 | String | 否 | |
| datasheet_id | 设备数据表标识 | String | 否 | |
| aprus_list | 适配器列表 | String | 否 | |
| mapping_id | 设备与适配器参数映射表标识 | String | 否 | |
| statistics_id | 统计计算标识 | String | 否 | |
| gis | 设备地理信息 | String | 否 | |
| secret | 管理密码 | String | 否 | |
| auth_code | 反向控制管理密码 | String | 否 | |
| equipment_image | 设备图片路径 | String | 否 | |
| addition | 附加字段/自定义字段 | Json | 否 | |
| template | 模板/样式 | text | 否 | |
| script | 脚本 | text | 否 | |
| reference | 参考号 | String | 否 |
addition数据格式说明(json格式):
[{"title": "锅炉信息","data": [["燃料类型","天然气"],["锅炉重量","2吨"],["出厂日期","2018-03-03"]]},{"title": "能效指标信息","data": [["热效率",0.8],["燃料热值",7000],["吨汽燃料指标",0.21]]}]```json返回参数:| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 ||--------|----------|----------|---------------------|----------|| code | 返回码 | Integer | 200:成功 500:失败 | 是 || msg | 提示信息 | String | | 是 || result | 返回结果 | Json | | 是 |返回示例:```json{"code": 200,"msg": "添加成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": []}
2.4.1.7.14.5. 删除Equipment
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/delete |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_id | 设备标识 | String | 是 |
返回参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| code | 返回码 | Integer | 200:成功 500:失败 | 是 |
| msg | 提示信息 | String | 是 | |
| result | 返回结果 | Json | 是 |
返回示例:
{"code": 200,"msg": "删除成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": []}
2.4.1.7.14.6. 查询Equipment反向控制列表
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/get_codebase_template |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_id | 设备标识 | String | 是 |
返回参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| code | 返回码 | Integer | 200:成功 500:失败 | 是 |
| msg | 提示信息 | String | 是 | |
| result | 返回结果 | Json | 是 |
返回示例:
{"code": 200,"msg": "查询成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": [{"aprus_id": "A22018083100003","aprus_name": "锅炉专用","codebase_id": 1001,"template": [["Control", "StartRemoteControl", "设备控制", "2", "L1_3_9", "1|2|4|8", "远程启动|远程停机|卸载|加载", "PEA"],["temp", "temp", "设备控制", "2", "L1_3_8", "$", "温度", "PEA"]]}]}
2.4.1.7.14.7. 查询Equipment故障和报警列表
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/get_warn_info |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_id | 设备标识 | String | 是 | |
| total | 查询记录数 | Integer | 大于 0,如果为空,则默认为 20 | 否 |
返回参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| code | 返回码 | Integer | 200:成功 500:失败 | 是 |
| msg | 提示信息 | String | 是 | |
| result | 返回结果 | Json | 是 |
返回示例:
{"code": 200,"msg": "查询成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": {"total_records": 3,"data": [{"id": 1002,"name": "锅炉过热","type": "alert","description": "Label_En:Oil Separator Blocked;Label_Cn:锅炉过热","created": "2018-09-11 17:03:07"},{"id": 1001,"name": "速度反馈错误","type": "fault","description": "Label_En:Speed Feedback Error;Label_Cn:速度反馈错误","created": "2018-09-03 15:43:32"},{"id": 1002,"name": "减速过电流","type": "fault","description": "Label_En:Retarded Overcurrent;Label_Cn:减速过电流","created": "2018-09-01 15:43:32"}]}}
2.4.1.7.14.8. 查询Equipment服务和作业列表
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/get_task_info |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_id | 设备标识 | String | 是 | |
| total | 查询记录数 | Integer | 大于 0,如果为空,则默认为 20 | 否 |
返回参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| code | 返回码 | Integer | 200:成功 500:失败 | 是 |
| msg | 提示信息 | String | 是 | |
| result | 返回结果 | Json | 是 |
返回示例:
{"code": 200,"msg": "查询成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": {"total_records": 3,"data": [{"id": 1001,"name": "施工服务","type": "service","description": "","date": "2018-11-30 09:16:18"},{"id": 1001,"name": "日常检修","type": "activity","description": "","date": "2018-11-30 09:16:18"},{"id": 1002,"name": "普通作业","type": "activity","description": "","date": "2018-11-30 09:16:18"}]}}
2.4.1.7.14.9. 查询 Equipment APP显示板信息
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/get_dashboard_template |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_id | 设备标识 | String | 是 |
返回参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| code | 返回码 | Integer | 200:成功 500:失败 | 是 |
| msg | 提示信息 | String | 是 | |
| result | 返回结果 | Json | 是 |
返回示例:
{"code": 200,"msg": "查询成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": {"equipment_id": 1001,"mapping_id": 1001,"template": [{"specialParameters": [{"title": "瞬时流量","key": "S01","value": "0","unit": "Nm³"}],"basicParameters": [{"title": "累计流量","key": "S04","value": "0","unit": "Nm³"}, {"title": "供气压力","key": "S05","value": "0","unit": "Mpa"}],"moreParameter": [{"class": "数值监控类","data": [{"title": "瞬时流量","key": "S01","value": "0","unit": "Nm³"}]}],"controlPanel": [{"title": "远程控制监控5","key": "S13","value": "0","unit": "h","max": "50","min": "0","color": "#ffffff"}]}]}}
2.4.1.7.14.10. 查询Equipment故障和报警挂板列表
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/get_mosaic_warn |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_id | 设备标识 | String | 是 | |
| page_index | 查询页码 | Integer | 大于 0,如果为空,则默认从第一页显示 | 否 |
| page_size | 每页记录数 | Integer | 大于 0,如果为空,则默认为 20 | 否 |
返回参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| code | 返回码 | Integer | 200:成功 500:失败 | 是 |
| msg | 提示信息 | String | 是 | |
| result | 返回结果 | Json | 是 |
返回示例:
{"code": 200,"msg": "success","mix_code":130001,"mix_msg":"","mix_ext":"","result": {"page_index": 1,"page_size": 20,"total_pages": 2,"total_records": 1,"data": [{"id": 1001,"name": "速度反馈错误","type": "fault","code": "7493","equipment_id": 1001,"aprus_id": "A22018083100002","description": "Label_En:Speed Feedback Error;Label_Cn:速度反馈错误","created": "2018-09-03 15:43:32"},{"id": 1001,"name": "油分器堵塞","type": "alert","code": "2514","equipment_id": 1002,"aprus_id": "A22018083100002","description": "Label_En:Oil Separator Blocked;Label_Cn:油分器堵塞","created": "2018-09-01 15:43:32"}]}}
2.4.1.7.14.11. 查询Equipment设备关联适配器的Fidis变量
调用接口:
| 属性 | 值 |
|---|---|
| url | /api/equipment/get_fidis_variable |
| http方法 | post |
| Content-Type | application/json或application/x-www-form-urlencoded |
请求参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| equipment_id | 设备标识 | String | 是 | |
| aprus_id | 适配器标识 | String | 如:A20180831003 | 是 |
| aprus_key | 参数上报Key | String | 如:L1_3_1 | 是 |
返回参数:
| 字段 | 字段名称 | 字段类型 | 说明 | 是否必传 |
|---|---|---|---|---|
| code | 返回码 | Integer | 200:成功 500:失败 | 是 |
| msg | 提示信息 | String | 是 | |
| result | 返回结果 | Json | 是 |
返回示例:
{"code": 200,"msg": "查询成功","mix_code":130001,"mix_msg":"","mix_ext":"","result": {"fidis_var": "S01"}}
