1. API接入地址

/device-monitor/v1/open/xxx

2. 公共参数说明

用户认证信息通过以下HTTP头传递：

Http Header名称 值说明
X-Token 通过统一认证获取的JWT Token

注：未携带Token直接访问API，将返回以下错误：

  1. {
  2.   "error": true,
  3.   "message": {
  4.     "code": "40003",
  5.     "description": "缺少token参数",
  6.     "params": [],
  7.     "type": "ERROR"
  8.   },
  9.   "path": "",
  10.   "success": false,
  11.   "timestamp": 1641125169156
  12. }

3.公共应答格式

3.1 操作成功返回样例

  1. {
  2.   "data": ...,
  3.   "error": false,
  4.   "extra": null,
  5.   "message": null,
  6.   "page": null,
  7.   "path": null,
  8.   "success": true,
  9.   "timestamp": 1641128783373
  10. }

3.2 分页查询返回样例

  1. {
  2.   "data": [
  3.     {
  4.       "deviceId": "128260939710464",
  5.       "deviceName": "机件加工",
  6.       "endTime": 1639381580841,
  7.       "id": "129129049489408",
  8.       "inputTime": "2021-12-13 15:45:29",
  9.       "inputUserId": null,
  10.       "modifyTime": "2021-12-13 15:46:20",
  11.       "modifyUserId": "43507d0a-802d-42eb-9deb-4dcdbe108356",
  12.       "periodSecond": 65,
  13.       "sigUid": "867038035289679",
  14.       "startTime": 1639381515000,
  15.       "status": "green",
  16.       "tenantId": "43507d0a-802d-42eb-9deb-4dcdbe108356",
  17.       "version": 1,
  18.       "workGroupName": "第三班",
  19.       "workareaName": "加工生产线",
  20.       "workshopName": "加工车间"
  21.     }
  22.   ],
  23.   "error": false,
  24.   "extra": null,
  25.   "message": null,
  26.   "page": {
  27.     "pageNo": 1,
  28.     "pageSize": 1,
  29.     "sorts": null,
  30.     "total": 3
  31.   },
  32.   "path": null,
  33.   "success": true,
  34.   "timestamp": 1641128832748
  35. }

3.3 操作失败返回样例

  1. {
  2.   "error": true,
  3.   "message": {
  4.     "code": "40003",
  5.     "description": "缺少token参数",
  6.     "params": [],
  7.     "type": "ERROR"
  8.   },
  9.   "path": "",
  10.   "success": false,
  11.   "timestamp": 1641128868473
  12. }

4. 查询接口说明

4.1 分页参数

分页通过URL参数传递，如未传递分页参数将返回所有符合条件的数据：

  1. #每页10条，返回第一页，按id倒序排列：
  2. GET  /device-monitor/api/v1/sig/SigDevice?pageNo=1&pageSize=10&column=id&order=desc
  4. #每页10条，返回第一页，默认排序
  5. GET /device-monitor/api/v1/sig/SigDevice?pageNo=1&pageSize=10

4.2 filter格式

filter参数为RSQL表达式：

基本格式，例如：

id==1 (检索id属性等于1的)

通过and或者or拼接多个表达式，例如：

id==1 and name==test （等价的写法：id==1;name==test）

支持通过括号表述分组/优先级，例如：

id==1 and (name==light or name==wind)

其他参考：

逻辑符号 说明 样例
;或者and 与 id==1;name==test
id==1 and name==test
,或者or 或 id==1,id==2
id==1 or id==2
比较符号 说明 样例
== 等于 name==test
!= 不等于 name!=test
=lt=或者< 小于 age=lt=18
=le=或者<= 小于等于 age=le=18
=gt=或者> 大于 age=gt=18
=ge=或者>= 大于等于 age=ge=18
=in= in name=in=(张三,李四)
=out= not in name=out=(张三,李四)
=na=null is null

嵌套对象的属性通过xxx.xxx指定，例如

  1. GET /api/v1/open/device?filter=workarea.name==生产线1;workarea.workshop.name==车间1