根据设备组名称查询设备组织树(支持设备组名称模糊查询)

功能介绍

URI

GET /v1/{user_id}/device-orgs/tree

表1 路径参数
参数	是否必选	参数类型	描述
user_id	是	String	用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

表2 Query参数
参数	是否必选	参数类型	描述
device_org_name	是	String	设备组织名称：支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围[1,50]

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
Access-Token	是	String	用户认证AccessToken：从获取用户北向接口认证AccessToken中获取

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
result	Array of QueryDeviceOrgTreeVo objects	响应信息

表5 QueryDeviceOrgTreeVo
参数	参数类型	描述
enterprise_id	String	企业ID，企业唯一标识符
device_org_id	String	设备组织ID
device_org_name	String	设备组织名称
parent_id	String	上级设备组织ID
device_org_level	Integer	设备组织级别，第一级子节点数值为1，第二级为2，以此类推
is_leaf	Integer	是否是叶子节点：枚举类型枚举值： 1 叶子节点，没有子级设备组织 0 非叶子节点，有子级设备组织
is_result	Integer	是否是查询结果
camera_count	Integer	设备数量
camera_online_count	Integer	在线设备数量
children	Array of query_device_org_tree_children objects	子组织信息

表6 query_device_org_tree_children
参数	参数类型	描述
device_org_id	String	设备组织ID
device_org_level	Integer	设备组织级别，第一级子节点数值为1，第二级为2，以此类推
device_org_name	String	设备组织名称
enterprise_id	Integer	企业ID，企业唯一标识
is_leaf	Integer	是否是叶子节点：枚举类型枚举值： 1 叶子节点，下没有子级设备组织 0 非叶子节点，下有子级设备组织
is_result	Integer	是否是查询结果
parent_id	String	上级设备组织ID
camera_count	Integer	设备数量
camera_online_count	Integer	在线设备数量
children	Array of query_device_org_tree_children objects	子组织信息

请求示例

根据设备组名称查询设备组织树(支持设备组名称模糊查询)

GET /v1/2562572829***/device-orgs/tree?device_org_name=研发

响应示例

状态码： 200

{
  "result" : [ {
    "enterprise_id" : "1230488562***",
    "device_org_id" : "1357924680***",
    "device_org_name" : "研发",
    "parent_id" : "1234567890***",
    "device_org_level" : 2,
    "is_leaf" : 0,
    "is_result" : 1,
    "camera_count" : 0,
    "camera_online_count" : 0,
    "children" : [ {
      "children" : [ ],
      "enterprise_id" : "1230488562***",
      "device_org_id" : "1357924680***",
      "device_org_name" : "Name",
      "parent_id" : "1234567890***",
      "device_org_level" : 2,
      "is_leaf" : 1,
      "is_result" : 1,
      "camera_count" : 0,
      "camera_online_count" : 0
    } ]
  } ]
}