功能描述
开始搜索团队。
接口说明
使用本接口发起异步搜索任务时,接口将在大约2s的时间返回,如果在返回时有部分或全部搜索结果,则返回已搜索出的结果的第一页(每页20个),如果暂未搜索到结果则返回空数组,因此该接口实际返回的 contents 数量可能为0到20之间不等,且是否还有更多搜索结果,不应参考 contents 的数量,而应参考 hasMore 字段。
当需要获取后续页时,使用 继续获取搜索结果 接口。
请求
请求示例
POST /user/v1/search/
{OrganizationId}
/team?check_children={CheckChildren}
&user_token={UserToken}
请求参数:
OrganizationId: 组织 ID,必选参数。
UserToken: 用户令牌,必选参数。
CheckChildren: 检查是否有 children,可选参数。
请求体
application/json
请求体示例:
{"keyword": "设计","ancestorId": 1}
请求体字段说明:
keyword: 字符串,搜索关键字,可使用空格分隔多个关键字,关键字之间为“或”的关系并优先展示匹配关键字较多的项目,可选参数。
ancestorId: 整数,搜索范围,指定搜索的祖先团队,如搜索所有团队可不指定该字段,可选参数。
响应
响应码
搜索成功,返回 HTTP 200 OK。
响应体
application/json
响应体示例:
{"searchId": "FkRIUkRlbUJMU1JLWlFxQVBuQkJyMGcfVUFhYUl5TGFSaTZtZUpDcEpUcEtxdzoxNDYzMTMyOQ==","hasMore": false,"nextMarker": 20,"contents": [{"id": 6,"name": "TeamB","parentId": 3,"spaceId": "space0eqd2l5yopzwm","path": ["TeamA_1","TeamB"],"pathNodes": [{"name": "TeamA_1","id": 3},{"name": "TeamB","id": 6}],"hasChildren": false,"userCount": 1},...]}
响应体字段说明:
searchId: 搜索任务 ID,用于异步获取搜索结果。
hasMore: 布尔型,是否有更多搜索结果。
nextMarker: 用于获取后续页的分页标识,仅当 hasMore 为 true 时才返回该字段。
contents: 第一页搜索结果,可能为空数组,有关异步搜索的说明请参阅【接口说明】。
id:整数,团队 ID。
name:字符串,团队名称。
parentId:整数,父团队 ID。
spaceId:字符串,团队空间 ID。
path:字符串数组,团队的层级目录,假设团层级为
T1/T2/T3
,则 T3 的 path 为 ['T1','T2','T3']
。pathNodes:对象数组,团队层级目录对象。
name:字符串,团队名称。
id:整数,团队 ID。
hasChildren:布尔值,是否有子级团队,仅当 CheckChildren = true,才返回该字段。
userCount:整数,团队成员数量。