NAYOTA开放平台
  • 开放接口
  • 设备管理
  • 设备API
Nayota
2022-03-15

检测器Api

# 说明

检测器的字段请查看字段说明

# 列表查询

接口说明

根据查询条件查询设备列表。

接口版本

v1

接口地址

/api-web-v1/checks

请求方法

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 depart string false 层级 _id
query query['tags'] string false 标签 {$all:['空调']}

请求参数举例

注意

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

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

返回参数

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

返回参数举例

{
  "code": 0,
  "data": {
    "total": 1007,
    "rows": [
      {
        "line": true,
        "value": 0,
        "valueStr": "",
        "boardConfigStr": "{}",
        "_id": "62948f33ec7041005ad4fd37",
        "name": "C相电流",
        "sort": 7,
        "company": "A",
        "icon": "icon-dianliuchuanganqi",
        "interval": null,
        "rosterName": null,
        "precision": 0.5,
        "canRead": true,
        "control": "6049a753d0cf2d001b97275a",
        "parentName": "Hardware",
        "parent": {
          "tags": [],
          "_id": "62948f32ec7041005ad4fd15",
          "name": "锻造车间2#中频加热炉",
          "line": true,
          "isShow": true,
          "type": 1,
          "status": 0,
          "loraSlave": "62946adaec7041005ad44911",
          "control": "6049a753d0cf2d001b97275a",
          "hardwareWord": "6030cfa3ec6781001b52f528",
          "serialData": {
            "_id": "6030cfa3ec6781001b52f52a",
            "comName": null,
            "baud": 1200,
            "verification": "even",
            "stopBit": 1,
            "dataBit": 8,
            "state": false,
            "address": null
          },
          "shortAddress": "422400201706",
          "line_status": 0,
          "creator": "602e05d2c40a0b001bb6161b",
          "attribute": [
            {
              "_id": "6030cfa3ec6781001b52f529",
              "key": "电能系数",
              "value": "1",
              "note": null
            }
          ],
          "__v": 2,
          "lineTime": "2022-05-30T09:57:49.141Z",
          "uiModel": null,
          "id": "62948f32ec7041005ad4fd15"
        },
        "shortAddress": "7",
        "creator": {
          "_id": "602e05d2c40a0b001bb6161b",
          "trueName": "智慧能源",
          "username": "13586887787"
        },
        "createdAt": "2022-05-30T09:32:35.999Z",
        "updatedAt": "2022-06-08T07:26:00.803Z",
        "__v": 0,
        "valueAt": "2022-06-08T07:26:00.763Z"
      }
    ]
  }
}

在线调试 (opens new window)

# 列表查询[POST]

接口说明

根据查询条件查询设备列表。传输数据量大时使用

接口版本

v1

接口地址

/api-web-v1/checks/list-post

请求方法

POST

请求参数

参数类型 参数名称 数据类型 是否必须 参数描述 默认 示例
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

请求参数举例 :::

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

返回参数

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

返回参数举例

{
  "code": 0,
  "data": {
    "total": 1007,
    "rows": [
      {
        "line": true,
        "value": 0,
        "valueStr": "",
        "boardConfigStr": "{}",
        "_id": "62948f33ec7041005ad4fd37",
        "name": "C相电流",
        "sort": 7,
        "company": "A",
        "icon": "icon-dianliuchuanganqi",
        "interval": null,
        "rosterName": null,
        "precision": 0.5,
        "canRead": true,
        "control": "6049a753d0cf2d001b97275a",
        "parentName": "Hardware",
        "parent": {
          "tags": [],
          "_id": "62948f32ec7041005ad4fd15",
          "name": "锻造车间2#中频加热炉",
          "line": true,
          "isShow": true,
          "type": 1,
          "status": 0,
          "loraSlave": "62946adaec7041005ad44911",
          "control": "6049a753d0cf2d001b97275a",
          "hardwareWord": "6030cfa3ec6781001b52f528",
          "serialData": {
            "_id": "6030cfa3ec6781001b52f52a",
            "comName": null,
            "baud": 1200,
            "verification": "even",
            "stopBit": 1,
            "dataBit": 8,
            "state": false,
            "address": null
          },
          "shortAddress": "422400201706",
          "line_status": 0,
          "creator": "602e05d2c40a0b001bb6161b",
          "attribute": [
            {
              "_id": "6030cfa3ec6781001b52f529",
              "key": "电能系数",
              "value": "1",
              "note": null
            }
          ],
          "__v": 2,
          "lineTime": "2022-05-30T09:57:49.141Z",
          "uiModel": null,
          "id": "62948f32ec7041005ad4fd15"
        },
        "shortAddress": "7",
        "creator": {
          "_id": "602e05d2c40a0b001bb6161b",
          "trueName": "智慧能源",
          "username": "13586887787"
        },
        "createdAt": "2022-05-30T09:32:35.999Z",
        "updatedAt": "2022-06-08T07:26:00.803Z",
        "__v": 0,
        "valueAt": "2022-06-08T07:26:00.763Z"
      }
    ]
  }
}

# 查询设备ID

接口说明

根据设备ID查询设备

接口版本

v1

接口地址

/api-web-v1/:model/:id

请求方法

GET

请求参数

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

请求参数举例

注意

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

{
  "model": "lora-slaves",
  "_id": "5da99fdd25daef001b464d87"
}

返回参数

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

返回参数举例

{
  "code": 0,
  "data": {
    "line": true,
    "value": 0,
    "valueStr": "",
    "boardConfigStr": "{}",
    "_id": "62948f33ec7041005ad4fd37",
    "name": "C相电流",
    "sort": 7,
    "company": "A",
    "icon": "icon-dianliuchuanganqi",
    "interval": null,
    "rosterName": null,
    "precision": 0.5,
    "canRead": true,
    "control": "6049a753d0cf2d001b97275a",
    "parentName": "Hardware",
    "parent": {
      "tags": [],
      "_id": "62948f32ec7041005ad4fd15",
      "name": "锻造车间2#中频加热炉",
      "line": true,
      "isShow": true,
      "type": 1,
      "status": 0,
      "loraSlave": "62946adaec7041005ad44911",
      "control": "6049a753d0cf2d001b97275a",
      "hardwareWord": "6030cfa3ec6781001b52f528",
      "serialData": {
        "_id": "6030cfa3ec6781001b52f52a",
        "comName": null,
        "baud": 1200,
        "verification": "even",
        "stopBit": 1,
        "dataBit": 8,
        "state": false,
        "address": null
      },
      "shortAddress": "422400201706",
      "line_status": 0,
      "creator": "602e05d2c40a0b001bb6161b",
      "attribute": [
        {
          "_id": "6030cfa3ec6781001b52f529",
          "key": "电能系数",
          "value": "1",
          "note": null
        }
      ],
      "__v": 2,
      "lineTime": "2022-05-30T09:57:49.141Z",
      "uiModel": null,
      "id": "62948f32ec7041005ad4fd15"
    },
    "shortAddress": "7",
    "creator": {
      "_id": "602e05d2c40a0b001bb6161b",
      "trueName": "智慧能源",
      "username": "13586887787"
    },
    "createdAt": "2022-05-30T09:32:35.999Z",
    "updatedAt": "2022-06-08T07:26:00.803Z",
    "__v": 0,
    "valueAt": "2022-06-08T07:26:00.763Z"
  }
}

在线调试 (opens new window)

# 编辑

接口说明

修改设备。第三方不建议直接调用设备修改接口，此接口使用需实际设备。

接口版本

v1

接口地址

/api-v1/checks/:id

请求方法

PUT

请求参数

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

请求参数举例

    {
  "name":"C相电流TSTS"
}

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

    返回参数

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

    返回参数举例

    {
    "code": 0,
    "data": {
    "line": true,
    "value": 0,
    "valueStr": "",
    "boardConfigStr": "{}",
    "_id": "62948f33ec7041005ad4fd37",
    "name": "C相电流TSTS",
    "sort": 7,
    "company": "A",
    "icon": "icon-dianliuchuanganqi",
    "interval": null,
    "rosterName": null,
    "precision": 0.5,
    "canRead": true,
    "control": "6049a753d0cf2d001b97275a",
    "parentName": "Hardware",
    "parent": {
      "tags": [],
      "_id": "62948f32ec7041005ad4fd15",
      "name": "锻造车间2#中频加热炉",
      "line": true,
      "isShow": true,
      "type": 1,
      "status": 0,
      "loraSlave": "62946adaec7041005ad44911",
      "control": "6049a753d0cf2d001b97275a",
      "hardwareWord": "6030cfa3ec6781001b52f528",
      "serialData": {
        "_id": "6030cfa3ec6781001b52f52a",
        "comName": null,
        "baud": 1200,
        "verification": "even",
        "stopBit": 1,
        "dataBit": 8,
        "state": false,
        "address": null
      },
      "shortAddress": "422400201706",
      "line_status": 0,
      "creator": "602e05d2c40a0b001bb6161b",
      "attribute": [
        {
          "_id": "6030cfa3ec6781001b52f529",
          "key": "电能系数",
          "value": "1",
          "note": null
        }
      ],
      "__v": 2,
      "lineTime": "2022-05-30T09:57:49.141Z",
      "uiModel": null,
      "id": "62948f32ec7041005ad4fd15"
    },
    "shortAddress": "7",
    "creator": {
      "_id": "602e05d2c40a0b001bb6161b",
      "trueName": "智慧能源",
      "username": "13586887787"
    },
    "createdAt": "2022-05-30T09:32:35.999Z",
    "updatedAt": "2022-06-08T07:26:00.803Z",
    "__v": 0,
    "valueAt": "2022-06-08T07:26:00.763Z"
  }
}

    第三方不建议直接调用设备修改接口，此接口修改需实际设备。文档不提供修改在线调试

    # 删除

    接口说明

    删除一个设备。第三方不建议直接调用设备删除接口，此接口需实际设备。

    接口版本

    v1

    接口地址

    /api-v1/checks/:id

    请求方法

    DELETE

    请求参数

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

    请求参数举例

    只需发送删除设备的ID

    返回参数

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

    返回参数举例

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

    第三方不建议直接调用设备删除接口，此接口需实际设备。文档不提供删除在线调试

    上次更新: 2023/03/20, 15:30:53
    Http设备Api
    控制器Api

    ← 控制器Api→

    Theme by Vdoing | Copyright © 2021-2023