有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

功能描述

查询团队。

请求

请求示例

GET /user/v1/team/{OrganizationId}/{TeamId}?check_permission&with_path={WithPath}&user_token={UserToken}
请求参数:
OrganizationId:组织 ID,必选参数。
TeamId:团队 ID,可选参数,不填则是查询根团队。
WithPath:是否带 team path, true | false,默认为 false,可选参数。
UserToken:用户令牌,必选参数。
check_permission:如果 query 中带 check_permission,则会检查权限(管理员列出所有团队,普通用户仅列出所属团队),可选参数。

请求体

该请求无请求体。

响应

响应码

查询成功,返回 HTTP 200 OK。

响应体

application/json
响应体示例:
{
"id":33,
"orgId":1,
"name":"B",
"parentId":1,
"spaceId":"space3rgfihr",
"defaultRoleId":1,
"userCount":32,
"path":[
"T1",
"T2"
],
"pathNodes":[
{
"id":1,
"name":"T1"
},
{
"id":33,
"name":"T2"
}
],
"children":[
{
"id":34,
"orgId":1,
"name":"BB",
"parentId":33,
"spaceId":"space3ehdn2neq8",
"defaultRoleId":1,
"children":[
{
"id":401,
"parentId":34
}
],
"userCount":1
},
{
"id":406,
"orgId":1,
"name":"bg",
"parentId":33,
"spaceId":"space1oju8hlble",
"defaultRoleId":1,
"children":[],
"userCount":0
}
]
}
响应体字段说明:
id:整数,团队 ID。
orgId:整数,组织 ID。
name:字符串,团队名称。
parentId:整数,父团队 ID。
spaceId:字符串,团队空间 ID。
path:字符串数组,团队的层级目录,假设团层级为 T1/T2/T3,则 T3 的 path 为 ['T1','T2','T3'],仅当 WithPath = true 时返回。
pathNodes:对象数组,团队层级目录对象,仅当 WithPath = true 时返回。
name:字符串,团队名称。
id:整数,团队 ID。
userCount:整数,团队成员数量。
defaultRoleId:整数,默认角色 ID。
children:对象数组,子级团队列表。
id:整数,团队 ID。
orgId:整数,组织 ID。
name:字符串,团队名称。
parentId:整数,父团队 ID。
spaceId:字符串,团队空间 ID。
userCount:整数,团队成员数量。
defaultRoleId:整数,默认角色 ID。
children:对象数组,子级团队列表。
id:整数,团队 ID。
parentId:整数,父团队 ID。