联动记录API
# 列表查询
接口说明
根据查询条件查询联动记录列表。
接口版本
v1接口地址
/api-v1/alert-records
请求方法
GET
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 | 默认 | 示例 |
---|---|---|---|---|---|---|
query | label | string | false | 模糊查询字段 | formType | |
query | search | string | false | 模糊查询值 | Smart | |
query | time | string | false | 时间范围查询字段,必须是设备字段中的时间或时间戳字段名,例如recordTime | recordTime | |
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格式编写
{
"page":"1",
"limit":"10",
"sort":"-_id",
"autopopulate":"false"
}
// Make sure to add code blocks to your code group
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 返回代码 |
data | json | True | 返回数据 |
-rows | array | False | 当前返回的联动记录对象列表 |
返回参数举例
{
"code": 0,
"data": {
"rows": [{
"checks": [
"62ce62735c6057005afae02f"
],
"operates": [
"62cd222618339f005a14248d"
],
"status": true,
"_id": "62ce647c5c6057005afae83f",
"recall": "3885cba6",
"formType": "Smart",
"formId": "62ce60e25c6057005afad82d",
"content": "test触发",
"__v": 0
}]
}
}
# 删除
接口说明
删除一个联动记录。
接口版本
v1接口地址
/api-v1/alert-records/:id
请求方法
DELETE
请求参数
参数类型 | 参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|---|
params | id | string | True | 删除的联动记录ID |
请求参数举例
只需发送删除记录的ID
返回参数
参数名称 | 数据类型 | 是否必须 | 参数描述 |
---|---|---|---|
code | number | True | 返回代码 |
data | string | false | 返回的数据 |
返回参数举例
{
"code": 0,
"data": {
"checks": [
"62ce62735c6057005afae02f"
],
"operates": [
"62cd222618339f005a14248d"
],
"status": true,
"_id": "62ce647c5c6057005afae83f",
"recall": "3885cba6",
"formType": "Smart",
"formId": "62ce60e25c6057005afad82d",
"content": "test触发",
"__v": 0
}
}
上次更新: 2022/07/26, 10:05:06