开放接口
规则引擎
规则引擎API

阈值设置API

# 说明

阈值设置的字段请查看字段说明

# 列表查询

接口说明

根据查询条件查询阈值设置列表。

接口版本

接口地址

/api-web-v1/thresholds

请求方法

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	指定关联表查询,查询多个关联表用逗号分隔		control

请求参数举例

注意

GET请求所有参数类型都会变成string拼接在url上面，文档为了表述清晰，将示例结构以json格式编写

{
  "page":"1",
  "limit":"10",
  "sort":"-createdAt",
  "autopopulate":"false"
}

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	True	返回数据
-total	number	False	阈值设置总条数
-rows	array	False	当前返回的阈值设置对象列表

返回参数举例

{
  "code": 0,
  "data": {
    "total": 1,
    "rows": [
      {
        "lastRun": false,
        "keepRun": 1,
        "alertType": true,
        "_id": "62188e7ccd3a8d003da45938",
        "control": "6180fc754276ad123c53754d",
        "term": [
          {
            "termType": 0,
            "timeRange": [],
            "tTypeValue": [
              "c",
              "6180fc754276ad123c53754d",
              "6180fc754276ad123c537555",
              "6215b03f9073e5003eb48911",
              "6216e5716a55e6005a5aa23a",
              "6216e5716a55e6005a5aa244"
            ],
            "_id": "62188e7ccd3a8d003da45939",
            "condition": 3,
            "min": 0,
            "max": 300,
            "check":  "6216e5716a55e6005a5aa244",
            "type": "c"
          }
        ],
        "action": [
          {
            "aTypeValue": [
              "p"
            ],
            "_id": "621891b6cd3a8d003da45bc6",
            "sort": 1,
            "performTime": 0,
            "performType": 4,
            "performContent": "234213424124",
            "type": "p",
            "interval": [
              {
                "value": 0,
                "label": "窗口提示"
              },
              {
                "value": 1,
                "label": "微信"
              },
              {
                "value": 4,
                "label": "邮件推送"
              },
              {
                "value": 5,
                "label": "MQTT推送"
              }
            ],
            "performUser": "1765181758@qq.com"
          }
        ],
        "status": true,
        "name": "A相电压阀值设定",
        "type": 0,
        "check": "6216e5716a55e6005a5aa244",
        "intervalTime": 300000,
        "creator": "5da855b71816bc001be72f4b",
        "createdAt": "2022-02-25T08:08:28.049Z",
        "updatedAt": "2022-05-26T10:28:15.638Z",
        "__v": 2,
        "lastRunTime": 1653301399964
      }
    ]
  }
}

在线调试 (opens new window)

# 查询阈值设置ID

接口说明

根据阈值设置ID查询阈值设置

接口版本

接口地址

/api-v1/thresholds/:id

请求方法

GET

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
params	id	string	True	阈值设置ID

请求参数举例

注意

GET请求所有参数类型都会拼接在url上面，文档为了表述清晰，将示例结构以json格式编写

{
  "_id": "62188e7ccd3a8d003da45938"
}

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	false	返回阈值设置信息

返回参数举例

{
  "code": 0,
  "data": {
    "lastRun": false,
    "keepRun": 1,
    "alertType": true,
    "_id": "62188e7ccd3a8d003da45938",
    "control": "6180fc754276ad123c53754d",
    "term": [
        {
        "termType": 0,
        "timeRange": [],
        "tTypeValue": [
            "c",
            "6180fc754276ad123c53754d",
            "6180fc754276ad123c537555",
            "6215b03f9073e5003eb48911",
            "6216e5716a55e6005a5aa23a",
            "6216e5716a55e6005a5aa244"
        ],
        "_id": "62188e7ccd3a8d003da45939",
        "condition": 3,
        "min": 0,
        "max": 300,
        "check":  "6216e5716a55e6005a5aa244",
        "type": "c"
        }
    ],
    "action": [
        {
        "aTypeValue": [
            "p"
        ],
        "_id": "621891b6cd3a8d003da45bc6",
        "sort": 1,
        "performTime": 0,
        "performType": 4,
        "performContent": "234213424124",
        "type": "p",
        "interval": [
            {
            "value": 0,
            "label": "窗口提示"
            },
            {
            "value": 1,
            "label": "微信"
            },
            {
            "value": 4,
            "label": "邮件推送"
            },
            {
            "value": 5,
            "label": "MQTT推送"
            }
        ],
        "performUser": "1765181758@qq.com"
        }
    ],
    "status": true,
    "name": "A相电压阀值设定",
    "type": 0,
    "check": "6216e5716a55e6005a5aa244",
    "intervalTime": 300000,
    "creator": "5da855b71816bc001be72f4b",
    "createdAt": "2022-02-25T08:08:28.049Z",
    "updatedAt": "2022-05-26T10:28:15.638Z",
    "__v": 2,
    "lastRunTime": 1653301399964
    }
}

在线调试 (opens new window)

# 新建

接口说明

新建一个阈值设置。

接口版本

接口地址

/api-v1/thresholds

请求方法

POST

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
body	-	Object	True	阈值设置对象字段说明

请求参数举例

{
  "keepRun": 1,
  "control": "6180fc754276ad123c53754d",
  "term": [
      {
      "termType": 0,
      "timeRange": [],
      "tTypeValue": [
          "c",
          "6180fc754276ad123c53754d",
          "6180fc754276ad123c537555",
          "6215b03f9073e5003eb48911",
          "6216e5716a55e6005a5aa23a",
          "6216e5716a55e6005a5aa244"
      ],
      "condition": 3,
      "min": 0,
      "max": 300,
      "check":  "6216e5716a55e6005a5aa244",
      "type": "c"
      }
  ],
  "action": [
      {
      "aTypeValue": [
          "p"
      ],
      "sort": 1,
      "performTime": 0,
      "performType": 4,
      "performContent": "234213424124",
      "type": "p",
      "interval": [
          {
          "value": 0,
          "label": "窗口提示"
          },
          {
          "value": 1,
          "label": "微信"
          },
          {
          "value": 4,
          "label": "邮件推送"
          },
          {
          "value": 5,
          "label": "MQTT推送"
          }
      ],
      "performUser": "1765181758@qq.com"
      }
  ],
  "status": true,
  "name": "A相电压阀值设定",
  "type": 0,
  "check": "6216e5716a55e6005a5aa244",
  "intervalTime": 300000,
  "creator": "5da855b71816bc001be72f4b",
}

// Make sure to add code blocks to your code group

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	True	返回创建的对象

返回参数举例

  {
    "lastRun": false,
    "keepRun": 1,
    "alertType": true,
    "_id": "62188e7ccd3a8d003da45938",
    "control": "6180fc754276ad123c53754d",
    "term": [
        {
        "termType": 0,
        "timeRange": [],
        "tTypeValue": [
            "c",
            "6180fc754276ad123c53754d",
            "6180fc754276ad123c537555",
            "6215b03f9073e5003eb48911",
            "6216e5716a55e6005a5aa23a",
            "6216e5716a55e6005a5aa244"
        ],
        "_id": "62188e7ccd3a8d003da45939",
        "condition": 3,
        "min": 0,
        "max": 300,
        "check":  "6216e5716a55e6005a5aa244",
        "type": "c"
        }
    ],
    "action": [
        {
        "aTypeValue": [
            "p"
        ],
        "_id": "621891b6cd3a8d003da45bc6",
        "sort": 1,
        "performTime": 0,
        "performType": 4,
        "performContent": "234213424124",
        "type": "p",
        "interval": [
            {
            "value": 0,
            "label": "窗口提示"
            },
            {
            "value": 1,
            "label": "微信"
            },
            {
            "value": 4,
            "label": "邮件推送"
            },
            {
            "value": 5,
            "label": "MQTT推送"
            }
        ],
        "performUser": "1765181758@qq.com"
        }
    ],
    "status": true,
    "name": "A相电压阀值设定",
    "type": 0,
    "check": "6216e5716a55e6005a5aa244",
    "intervalTime": 300000,
    "creator": "5da855b71816bc001be72f4b",
    "createdAt": "2022-02-25T08:08:28.049Z",
    "updatedAt": "2022-05-26T10:28:15.638Z",
    "__v": 2,
    "lastRunTime": 1653301399964
}

# 编辑

接口说明

修改阈值设置。

接口版本

接口地址

/api-v1/thresholds/:id

请求方法

PUT

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
params	id	string	True	修改的阈值设置ID
body	-	Object	True	阈值设置对象字段说明

请求参数举例

{
  "name":"1楼A相电压阀值"
}

// Make sure to add code blocks to your code group

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
data	json	True	返回创建的对象

返回参数举例

{
  "code": 0,
  "data": {
    "lastRun": false,
    "keepRun": 1,
    "alertType": true,
    "_id": "62188e7ccd3a8d003da45938",
    "control": "6180fc754276ad123c53754d",
    "term": [
      {
        "termType": 0,
        "timeRange": [],
        "tTypeValue": [
          "c",
          "6180fc754276ad123c53754d",
          "6180fc754276ad123c537555",
          "6215b03f9073e5003eb48911",
          "6216e5716a55e6005a5aa23a",
          "6216e5716a55e6005a5aa244"
        ],
        "_id": "62188e7ccd3a8d003da45939",
        "condition": 3,
        "min": 0,
        "max": 300,
        "check": "6216e5716a55e6005a5aa244",
        "type": "c"
      }
    ],
    "action": [
      {
        "aTypeValue": [
          "p"
        ],
        "_id": "621891b6cd3a8d003da45bc6",
        "sort": 1,
        "performTime": 0,
        "performType": 4,
        "performContent": "234213424124",
        "type": "p",
        "interval": [
          {
            "value": 0,
            "label": "窗口提示"
          },
          {
            "value": 1,
            "label": "微信"
          },
          {
            "value": 4,
            "label": "邮件推送"
          },
          {
            "value": 5,
            "label": "MQTT推送"
          }
        ],
        "performUser": "1765181758@qq.com"
      }
    ],
    "status": true,
    "name": "1楼A相电压阀值",
    "type": 0,
    "check": "6216e5716a55e6005a5aa244",
    "intervalTime": 300000,
    "creator": "5da855b71816bc001be72f4b",
    "createdAt": "2022-02-25T08:08:28.049Z",
    "updatedAt": "2022-07-12T10:26:59.802Z",
    "__v": 3,
    "lastRunTime": 1653301399964
  }
}

# 删除

接口说明

删除一个阈值设置。

接口版本

接口地址

/api-v1/thresholds/:id

请求方法

DELETE

请求参数

参数类型	参数名称	数据类型	是否必须	参数描述
params	id	string	True	删除的阈值设置ID

请求参数举例

只需发送删除阈值设置的ID

返回参数

参数名称	数据类型	是否必须	参数描述
code	number	True	是否成功
message	string	false	成功删除返回complete

返回参数举例

{
    "code": 0,
    "message": "complete"
}

此接口需实际阈值设置。文档不提供删除在线调试

上次更新: 2022/07/13, 14:05:11

← 智能联动API 数据清洗Api→