分组管理

分组列表查询

请求URL

https://www.thingshub.com.cn/openapi/v2/group/list

方法

GET

Content-Type

application/x-www-form-urlencoded

请求参数

参数	数据类型	必填	说明
name	string	否	分组名称
level	int	否	分组级别
pageNumber	int	否	页码
pageSize	int	否	页大小

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	是	返回数据
+total	int	是	总记录数
+records	array	是	分组列表
++groupId	int	是	分组ID
++groupName	string	是	分组名称
++createTime	string	是	创建时间
++remark	string	是	分组描述
++level	int	是	分组级别

响应样例

{
  "code": 200,
  "msg": "success",
  "data": {
    "total": 8,
    "records": [
      {
        "groupId": 67,
        "groupName": "智慧农业养鸡场",
        "createTime": "2020-07-02 10:50:56",
        "remark": "",        
        "level": 1
      },
      {
        "groupId": 72,
        "groupName": "测温设备",
        "createTime": "2020-07-21 14:04:19",
        "remark": "abc",
        "level": 1
      }
    ]
  }
}

用户分组树

请求URL

https://www.thingshub.com.cn/openapi/v2/group/menu

方法

GET

Content-Type

无

请求参数

无

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	array	是	返回数据
+value	int	是	分组ID
+userId	string	是	用户ID
+projectCode	string	是	项目编码
+parentId	int	是	父组ID
+level	int	是	分组级别
+createTime	string	是	创建时间
+remark	string	是	备注
+key	int	是	分组ID
+title	string	是	分组
+children	array	是	子分组

响应样例

{
  "code": 200,
  "msg": "success",
  "data": [
    {
      "value": 106,
      "userId": "",
      "projectCode": "ufLV0xtzRj",
      "parentId": null,
      "level": 0,
      "createTime": "2021-07-15T06:39:37.000+00:00",
      "remark": ": 根分组",
      "key": 106,
      "title": "分组",
      "children": [
        {
          "value": 67,
          "userId": "",
          "projectCode": "ufLV0xtzRj",
          "parentId": 106,
          "level": 1,
          "createTime": "2020-07-02T02:50:56.000+00:00",
          "remark": "",
          "key": 67,
          "title": "智慧农业养鸡场",
          "children": []
        }
      ]
    }
  ]
}

分组创建

请求URL

https://www.thingshub.com.cn/openapi/v2/group/save

方法

POST

Content-Type

application/x-www-form-urlencoded

请求参数

参数	数据类型	必填	说明
projectCode	string	否	项目编码
pid	int	是	父分组ID
name	string	是	分组名称
remark	string	否	备注

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息

响应样例

{
	"code": 200,
    "msg": "success"
}

分组删除

请求URL

https://www.thingshub.com.cn/openapi/v2/group/delete

方法

POST

Content-Type

application/x-www-form-urlencoded

请求参数

参数	数据类型	必填	说明
id	int	是	分组ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息

响应样例

{
	"code": 200,
	"msg": "success"
}

子分组查询

请求URL

https://www.thingshub.com.cn/openapi/v2/group/children

方法

GET

Content-Type

无

请求参数

参数	数据类型	必填	说明
gid	int	是	分组ID
name	string	否	分组名称
pageNumber	int	否	页码
pageSize	int	否	页大小

响应样例

分组详情

请求URL

https://www.thingshub.com.cn/openapi/v2/group/detail

方法

GET

Content-Type

无

请求参数

参数	数据类型	必填	说明
gid	int	是	分组ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	是	返回数据
+groupId	int	是	分组ID
+groupName	string	是	分组名称
+createTime	string	是	创建时间
+remark	string	是	分组描述
+groupLevel	string	是	分组路径
+deviceTotal	int	是	设备总数
+activeTotal	int	是	激活设备数
+onlineTotal	int	是	在线设备数
+level	int	是	分组级别

响应样例

{
  "code": 200,
  "msg": "success",
  "data": {
    "groupId": 132,
    "groupName": "安顺市",
    "createTime": "2022-07-28 16:38:05",
    "remark": "",
    "groupLevel": "贵州加油站/安顺市",
    "deviceTotal": 0,
    "activeTotal": 0,
    "onlineTotal": 0,
    "level": 2
  }
}

分组下设备列表

请求URL

https://www.thingshub.com.cn/openapi/v2/group/device-page

方法

GET

Content-Type

无

请求参数

参数	数据类型	必填	说明
gid	int	是	分组ID
productKey	string	否	ProductKey
deviceName	string	否	DeviceName
pageNumber	int	否	页码
pageSize	int	否	页大小

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息
data	object	是	返回数据
+total	int	是	总记录数
+records	array	是	设备列表
++deviceId	int	是	设备ID
++deviceName	string	是	DeviceName
++status	string	是	设备状态
++productKey	string	是	ProductKey
++productName	string	是	产品名称
++nodeType	int	是	设备节点类型
++groupId	int	是	分组ID

响应样例

{
  "code": 200,
  "msg": "success",
  "data": {
    "total": 2,
    "records": [
      {
        "deviceId": 6550,
        "deviceName": "ZCshiyan04",
        "status": "INACTIVE",
        "productKey": "srUkdnUTspQ",
        "productName": "振昌试验站",
        "nodeType": "0",
        "groupId": 72
      },
      {
        "deviceId": 6548,
        "deviceName": "ZCshiyan03",
        "status": "INACTIVE",
        "productKey": "srUkdnUTspQ",
        "productName": "振昌试验站",
        "nodeType": "0",
        "groupId": 72
      }
    ]
  }
}

添加设备到分组

请求URL

https://www.thingshub.com.cn/openapi/v2/group/children/add-device

方法

POST

Content-Type

application/x-www-form-urlencoded

请求参数

参数	数据类型	必填	说明
gid	int	是	分组ID
deviceId	string	是	逗号分隔

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息

响应样例

从分组移除设备

请求URL

https://www.thingshub.com.cn/openapi/v2/group/children/remove-device

方法

POST

Content-Type

application/x-www-form-urlencoded

请求参数

参数	数据类型	必填	说明
gid	int	是	分组ID
deviceId	int	是	设备ID

响应参数

参数	数据类型	必填	说明
code	int	是	返回码
msg	string	是	返回消息

响应样例