设备分组

xiaolizi大约 4 分钟

设备分组

创建设备分组

POST	/admin-api/iot/device-group/create

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
name	名称	json	true	string
identifier	分组标识，推荐：英文和数字组合，以英文或下划线开头	json	true	str
description	描述	json	false	string
parentId	父id	json	false	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	创建成功返回Id	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": 1419193028346640,
  "msg": ""
}

获取设备分组列表

GET	/admin-api/iot/device-group/list

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
name	设备分组名称，用于过滤name的设备分组	query	false	string
identifier	设备分组标识，用于过滤identifier的设备分组	query	false	string
parentId	父id	query	false	long
description	描述，模糊搜索description内容	query	false	string
createTime	创建时间时间范围，示例值（2024-11-12 00:00:00 - 2024-11-29 23:59:59）	query	false	array[datatime]
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	查询成功后返回数据列表	array
---id	设备分组id	long
---name	设备分组名称	string
---identifier	设备分组标识	string
---description	描述	string
---parentId	父id	long
---createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": [
    {
      "name": "我家主卧设备",
      "identifier": "dewd",
      "description": "我家主卧的全部设备分组",
      "parentId": 0,
      "id": 1412004054228992,
      "createTime": 1723637762000
    }
  ],
  "msg": ""
}

获取设备分组

GET	/admin-api/iot/device-group/get

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	id	query	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	获取返回的对象	object
---id	设备分组id	long
---name	设备分组名称	string
---identifier	设备分组标识	string
---description	描述	string
---parentId	父id	long
---createTime	创建时间，时间戳	long
msg	状态消息	string

响应示例

{
    "status": 0,
    "code": 0,
    "data": {
          "name": "我家主卧设备",
          "identifier": "dewd",
          "description": "我家主卧的全部设备分组",
          "parentId": 0,
          "id": 1412004054228992,
          "createTime": 1723637762000
     },
    "msg": ""
}

更新设备分组

PUT	/admin-api/iot/device-group/update

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	要更新的设备分组id	json	true	long
name	设备分组名称	json	false	string
identifier	设备分组标识，推荐：英文和数字组合，以英文或下划线开头	json	false	string
description	描述	json	false	string
parentId	父id	json	false	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	更新成功返回true	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}

删除设备分组

DELETE	/admin-api/iot/device-group/delete

请求数据类型：application/json;charset=UTF-8

请求参数

参数名称	参数说明	请求类型	是否必须	数据类型
id	要删除的设备分组id	json	true	long
Authorization	认证 Token,示例值(Bearer be080642804d4af285ccccaefcb66eda) 获取access_token请参考获取访问令牌	header	true	string

响应状态

状态码	说明
200	OK

响应参数

参数名称	参数说明	数据类型
status	状态码，值为0正常，其他值为异常	int
code	结果同status一样，冗余字段	int
data	删除成功返回true	boolean
msg	状态消息	string

响应示例

{
  "status": 0,
  "code": 0,
  "data": true,
  "msg": ""
}