查询组织列表 - ListOrganizations

功能介绍

查询指定组织及其下的子组织列表。

接口约束

null

URI

GET /api/v2/tenant/organizations

表1 Query参数
参数	是否必选	参数类型	描述
all_child	否	Boolean	是否获取所有层级子组织。
limit	是	Integer	每页多少条。
offset	是	Integer	第几页。
org_id	否	String	组织id。当org_id=空，all_child=false，返回所有根组织（最高层级的组织）列表信息；当org_id=空，all_child=true，返回除了根组织外，其他所有子组织列表信息；当org_id=orgId，all_child=true，返回该组织以及该组织下所有层级子组织列表信息；当org_id=orgId，all_child=false，返回该组织以及该组织的下一级组织列表信息。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Authorization	是	String	认证凭据，值：Bearer {access_token}，access_token通过“获取访问凭据”接口获取。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
total	Long	组织总数。
organizations	Array of ResponseOrgInfo objects	组织列表。

表4 ResponseOrgInfo
参数	参数类型	描述
org_id	String	组织id。
org_code	String	组织编号，全局唯一。
name	String	组织名称，所在层级下唯一。
parent_id	String	父组织id。
category	String	组织类型。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误编号。
error_msg	String	错误详情。

请求示例

以分页形式查询组织列表，返回除了根组织外，其他所有子组织列表信息的前100条，不满100条时，则返回实际数量的信息结果。

GET https://{domain_name}/api/v2/tenant/organizations?org_id=&all_child=true&offset=0&limit=100

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

响应示例

状态码：200

请求成功。

{
  "total" : 2,
  "organizations" : [ {
    "org_code" : "1000000",
    "org_id" : "20210619175242949-6040-CA7ECF...",
    "name" : "总部",
    "category" : "department",
    "parent_id" : null
  }, {
    "org_code" : "1000001",
    "org_id" : "20210623103509267-6ABA-201FFC...",
    "name" : "子部门",
    "category" : "department",
    "parent_id" : "20210619175242949-6040-CA7ECF..."
  } ]
}