展示设备api
# 说明
所有的设备都有这些Api接口,只是不通的设备的字段和数据有所不同
展示设备的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询设备列表。
接口版本
v1接口地址
/api-web-v1/devices
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
query | time | string | false | 时间范围查询字段,必须是设备字段中的时间或时间戳字段名,例如createdAt,updatedAt | createdAt | |
query | range | string[] or string | false | 时间范围,开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 | 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z | |
query | page | number | false | 分页第几页 | 1 | |
query | limit | number | false | 单页几条数据 | 10 | |
query | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- | ||
query | autopopulate | boolean | false | 自动关联数据,部分字段自动关联关系表查询,设置这个值可开关自动联表查询 | true | false |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"page":"1",
"limit":"2",
"sort":"-_id"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
-total | number | False | 设备总条数 |
-rows | array | False | 当前返回的设备对象列表 |
返回参数举例
{
"code": 0,
"data": {
"total": 182,
"rows": [{
"creators": [],
"tags": [],
"_id": "63ef167a9f44f5a4913bdbf6",
"name": "室外温湿度",
"deviceUI": {
"uiWidth": 350,
"_id": "63ef15d09f44f56d8a3bda00",
"name": "室外温湿度",
"code": "2",
"path": "http://115.231.215.182:4048/api/uploads/63ef15bedf5f0d0008178fe1/温湿度.png"
},
"props": [{
"device": {
"_id": "636b06712cab4067f77d9fc8",
"name": "bacnet中控1"
},
"_id": "63f5c09c9f44f5305a4df600",
"deviceType": "HttpDrive",
"propType": "Check",
"prop": {
"line": true,
"value": 48.01,
"valueStr": null,
"_id": "636b3259c310a5e72369f436",
"name": "室外湿度",
"valueAt": "2023-02-28T07:09:06.607Z"
},
"code": "室外湿度",
"isImport": true
}, {
"device": {
"_id": "636b06712cab4067f77d9fc8",
"name": "bacnet中控1"
},
"_id": "63f5c09c9f44f55a964df601",
"deviceType": "HttpDrive",
"propType": "Check",
"prop": {
"line": true,
"value": 21.51,
"valueStr": null,
"_id": "636b325ac310a5b14969f438",
"name": "室外温度",
"valueAt": "2023-02-28T07:09:06.607Z"
},
"code": "室外温度"
}],
"creator": {
"_id": "62c51f57d8a1bd26a35482e0",
"trueName": "宁波迦南智能电气股份有限公司",
"username": "nb_jnzn"
},
"createdAt": "2023-02-17T05:54:02.551Z",
"updatedAt": "2023-02-22T07:13:32.052Z",
"line": true,
"lineTime": "2023-02-28T07:09:06.607Z",
"propError": false,
"id": "63ef167a9f44f5a4913bdbf6"
}]
}
}
# 查询单个设备
接口说明
根据查询条件查询单个设备。
接口版本
v1接口地址
/api-web-v1/devices/one
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
query | time | string | false | 时间范围查询字段,必须是设备字段中的时间或时间戳字段名,例如createdAt,updatedAt | createdAt | |
query | range | string[] or string | false | 时间范围,开始时间到结束时间,可以是string[]或者以逗号分割的开始时间到结束时间或时间戳 | 2019-10-22T00:00:00.000Z,2022-01-22T00:00:00.000Z | |
query | sort | string | false | 根据哪个字段排序 | _id | -createdAt |
query | select | string | false | 只查询部分字段,字段名之间用过空格分隔,去掉某个字段的查询字段名前面加- | ||
query | autopopulate | boolean | false | 自动关联数据,部分字段自动关联关系表查询,设置这个值可开关自动联表查询 | true | false |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"name":"室外温湿度"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
返回参数举例
{
"code": 0,
"data": {
"creators": [],
"tags": [],
"_id": "63ef167a9f44f5a4913bdbf6",
"name": "室外温湿度",
"deviceUI": {
"uiWidth": 350,
"_id": "63ef15d09f44f56d8a3bda00",
"name": "室外温湿度",
"code": "2",
"path": "http://115.231.215.182:4048/api/uploads/63ef15bedf5f0d0008178fe1/温湿度.png"
},
"props": [{
"device": {
"_id": "636b06712cab4067f77d9fc8",
"name": "bacnet中控1"
},
"_id": "63f5c09c9f44f5305a4df600",
"deviceType": "HttpDrive",
"propType": "Check",
"prop": {
"line": true,
"value": 48.01,
"valueStr": null,
"_id": "636b3259c310a5e72369f436",
"name": "室外湿度",
"valueAt": "2023-02-28T07:09:06.607Z"
},
"code": "室外湿度",
"isImport": true
}, {
"device": {
"_id": "636b06712cab4067f77d9fc8",
"name": "bacnet中控1"
},
"_id": "63f5c09c9f44f55a964df601",
"deviceType": "HttpDrive",
"propType": "Check",
"prop": {
"line": true,
"value": 21.51,
"valueStr": null,
"_id": "636b325ac310a5b14969f438",
"name": "室外温度",
"valueAt": "2023-02-28T07:09:06.607Z"
},
"code": "室外温度"
}],
"creator": {
"_id": "62c51f57d8a1bd26a35482e0",
"trueName": "宁波迦南智能电气股份有限公司",
"username": "nb_jnzn"
},
"createdAt": "2023-02-17T05:54:02.551Z",
"updatedAt": "2023-02-22T07:13:32.052Z",
"line": true,
"lineTime": "2023-02-28T07:09:06.607Z",
"propError": false,
"id": "63ef167a9f44f5a4913bdbf6"
}
}
# 查询设备ID
接口说明
根据设备ID查询设备
接口版本
v1接口地址
/api-v1/devices/:id
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 设备ID |
请求参数举例
注意
GET请求所有参数类型都会拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
"_id": "63ef167a9f44f5a4913bdbf6"
}
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | false | 返回设备信息 |
返回参数举例
{
"code": 0,
"data": {
"creators": [],
"tags": [],
"_id": "63ef167a9f44f5a4913bdbf6",
"name": "室外温湿度",
"deviceUI": {
"uiWidth": 350,
"_id": "63ef15d09f44f56d8a3bda00",
"name": "室外温湿度",
"code": "2",
"path": "http://115.231.215.182:4048/api/uploads/63ef15bedf5f0d0008178fe1/温湿度.png"
},
"props": [{
"device": {
"_id": "636b06712cab4067f77d9fc8",
"name": "bacnet中控1"
},
"_id": "63f5c09c9f44f5305a4df600",
"deviceType": "HttpDrive",
"propType": "Check",
"prop": {
"line": true,
"value": 48.01,
"valueStr": null,
"_id": "636b3259c310a5e72369f436",
"name": "室外湿度",
"valueAt": "2023-02-28T07:09:06.607Z"
},
"code": "室外湿度",
"isImport": true
}, {
"device": {
"_id": "636b06712cab4067f77d9fc8",
"name": "bacnet中控1"
},
"_id": "63f5c09c9f44f55a964df601",
"deviceType": "HttpDrive",
"propType": "Check",
"prop": {
"line": true,
"value": 21.51,
"valueStr": null,
"_id": "636b325ac310a5b14969f438",
"name": "室外温度",
"valueAt": "2023-02-28T07:09:06.607Z"
},
"code": "室外温度"
}],
"creator": {
"_id": "62c51f57d8a1bd26a35482e0",
"trueName": "宁波迦南智能电气股份有限公司",
"username": "nb_jnzn"
},
"createdAt": "2023-02-17T05:54:02.551Z",
"updatedAt": "2023-02-22T07:13:32.052Z",
"line": true,
"lineTime": "2023-02-28T07:09:06.607Z",
"propError": false,
"id": "63ef167a9f44f5a4913bdbf6"
}
}
# 新建
接口说明
新建一个设备。第三方不建议直接调用设备新建接口,此接口创建需实际设备。
接口版本
v1接口地址
/api-v1/devices
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 设备对象字段说明 |
第三方不建议直接调用设备新建接口,此接口创建需实际设备。文档不提供新增在线调试
# 编辑
接口说明
修改设备。第三方不建议直接调用设备修改接口,此接口使用需实际设备。
接口版本
v1接口地址
/api-v1/devices/:id
请求方法
PUT
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 修改的设备ID |
body | - | Object | True | 设备对象字段说明 |
第三方不建议直接调用设备修改接口,此接口修改需实际设备。文档不提供修改在线调试
# 删除
接口说明
删除一个设备。第三方不建议直接调用设备删除接口,此接口需实际设备。
接口版本
v1接口地址
/api-v1/devices/:id
请求方法
DELETE
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 删除的设备ID |
请求参数举例
只需发送删除设备的ID
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
message | string | false | 成功删除返回complete |
返回参数举例
{
"code": 0,
"message": "complete"
}
第三方不建议直接调用设备删除接口,此接口需实际设备。文档不提供删除在线调试