区域类别Api
区域类别的字段请查看字段说明
# 列表查询
接口说明
根据查询条件查询区域类别列表。
接口版本
v1接口地址
/api-v1/display-area-classs
请求方法
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 |
query | populate | string | false | 指定关联表查询,查询多个关联表用逗号分隔 | checks,operates |
请求参数举例
注意
GET请求所有参数类型都会变成string拼接在url上面,文档为了表述清晰,将示例结构以json格式编写
```json
{
"page":"1",
"limit":"2",
"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": 1,
"rows": [{
"showStatus": true,
"displayArea": ["62b2be5737f690517bcb0ef9"],
"isCloud": false,
"_id": "62b2be5737f690517bcb0ef9",
"name": "name",
"control": "5dc3e6a55b5edb001c2c14e4",
"creator": "5dc3e4795b5edb001c2c1314",
"createdAt": "2022-06-22T07:01:43.973Z",
"updatedAt": "2022-06-22T07:01:43.973Z",
"__v": 0
}]
}
}
# 新建
接口说明
新建一个区域类别。
接口版本
v1接口地址
/api-v1/display-area-classs/
请求方法
POST
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | - | Object | True | 区域类别对象字段说明 |
请求参数举例
{
"showStatus": true,
"displayArea": ["62b2be5737f690517bcb0ef9"],
"isCloud": false,
"name": "name",
"control": "5dc3e6a55b5edb001c2c14e4",
"creator": "5dc3e4795b5edb001c2c1314",
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 返回代码 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"showStatus": true,
"displayArea": ["62b2be5737f690517bcb0ef9"],
"isCloud": false,
"_id": "62b2be5737f690517bcb0ef9",
"name": "name",
"control": "5dc3e6a55b5edb001c2c14e4",
"creator": "5dc3e4795b5edb001c2c1314",
"createdAt": "2022-06-22T07:01:43.973Z",
"updatedAt": "2022-06-22T07:01:43.973Z",
"__v": 0
}
}
# 编辑
接口说明
修改区域类别。
接口版本
v1接口地址
/api-v1/display-area-classs/:id
请求方法
PUT
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 修改的区域类别ID |
body | - | Object | True | 区域类别对象字段说明 |
请求参数举例
{
"name":"updatename"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 返回代码 |
data | json | True | 返回创建的对象 |
返回参数举例
{
"code": 0,
"data": {
"showStatus": true,
"displayArea": ["62b2be5737f690517bcb0ef9"],
"isCloud": false,
"_id": "62b2be5737f690517bcb0ef9",
"name": "updatename",
"control": "5dc3e6a55b5edb001c2c14e4",
"creator": "5dc3e4795b5edb001c2c1314",
"createdAt": "2022-06-22T07:01:43.973Z",
"updatedAt": "2022-06-22T07:01:43.973Z",
"__v": 0
}
}
# 删除
接口说明
删除一个区域类别。
接口版本
v1接口地址
/api-v1/display-area-classs/:id
请求方法
DELETE
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 删除的区域类别ID |
请求参数举例
只需发送删除记录的ID
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 返回代码 |
data | string | false | 成功删除返回 |
返回参数举例
{
"code": 0,
"data": {
"showStatus": true,
"displayArea": ["62b2be5737f690517bcb0ef9"],
"isCloud": false,
"_id": "62b2be5737f690517bcb0ef9",
"name": "name",
"control": "5dc3e6a55b5edb001c2c14e4",
"creator": "5dc3e4795b5edb001c2c1314",
"createdAt": "2022-06-22T07:01:43.973Z",
"updatedAt": "2022-06-22T07:01:43.973Z",
"__v": 0
}
}
# 数据同步
接口说明
执行数据同步,把云端的区域类别数据同步到主机端。
接口版本
v1接口地址
/api-v1/display-area-calss/mqtt-client
请求方法
POST
post请求体参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
body | username | String | true | 用户账户名称 |
body | clientId | ObjectId | true | 客户端id |
body | controlId | ObjectId | true | 网关id |
请求参数举例
{
"clientId": "nayota5g-64-21051301",
"username": "username",
"controlId": "5e16dcdb7d3892001baabaca"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 返回代码 |
message | string | false | 返回说明信息 |
返回参数举例
{
"code": 0,
"message": "ok"
}
上次更新: 2022/06/28, 15:55:53