计量设备API
# 检测器数据接口
字段说明
字段请查看字段说明
接口说明
根据查询条件查询检测器数据
接口版本
v1接口地址
https://energy.25soft.com/api/checks
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | name | |
query | search | string | false | 模糊查询值 | 测试 | |
query | time | string | false | 时间范围查询字段,必须是层级中的时间或时间戳字段名,例如createdAt,updatedAt | createdAt | |
query | range | 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":"10",
"sort":"-createdAt",
"autopopulate":"false"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
-total | number | False | 串口设备总条数 |
-rows | array | False | 当前返回的串口设备对象列表 |
返回参数举例
{
"code": 0,
"data": {
"total": 11,
"rows": [
{
"name": "A相有功功率",
"alias": "管棒北柜-A相有功功率",
"isPower": false,
"standbyPower": 0,
"remark": "",
"company": "kW",
"magnification": 1,
"groupTag": "",
"buildingId": "",
"extId": "",
"openValue": 0,
"isUsed": false,
"_id": "61cac84981c6aa005448e2fa",
"value": null,
"shortAddress": "8",
"creator": "602e05d2c40a0b001bb6161b",
"createdAt": "2021-12-28T08:18:17.791Z",
"updatedAt": "2021-12-28T08:18:17.791Z",
"__v": 0,
"device": "61d85113b2917bbe345db04f",
"type": 0
}
]
}
}
:::
接口版本
v1接口地址
https://energy.25soft.com/api/checks/readLine
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | model | string | false | 查询类型 | 类型,设备:'check',层级:'depart' | |
query | datas | objectIds[] | false | 设备IDs,可以是objectIds[] | [] |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
{
model:'check',
datas:['61cac84981c6aa005448e2fa']
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 是否成功 |
data | json | True | 返回数据 |
-total | number | False | 串口设备总条数 |
-rows | array | False | 当前返回的串口设备对象列表 |
返回参数举例
{
"code": 0,
"data": [
{
"name": "A相有功功率",
"_id": "61cac84981c6aa005448e2fa",
"line": true
},
{
"name": "A相有功功率",
"_id": "61cac84981c6aa005448e2fb",
"line": false
}
]
}
# Nayota检测器数据接口
上次更新: 2022/07/22, 14:20:26