搜索部门
适用版本>=v7.0.2412b.20241226
接口说明:搜索部门
请求说明
| 请求地址 | 配置域名+/openapi+/v7/depts/search |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 查询和管理通讯录信息(用户授权)kso.contact.readwrite 查询通讯录信息(用户授权) kso.contact.read |
请求头(Header)
| Header | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| keyword | string | 是 | 搜索关键字 |
| page_size | int64 | 是 | 分页大小,最小值:1,最大值:50 |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果;当查询结果中next_page_token为空或无该返回值时,代表无下一页。 |
| search_source | string[] | 否 | 搜索范围,可选值: company_dept:本企业部门; enterprise_partner:关联组织部门; 格式为 search_source={string_1}&search_source={string_2} |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | int | 错误码 |
| detail | string | 详细信息 |
| msg | string | 状态信息 |
| data | object | 返回信息体 |
| ∟ items | object[] | 部门信息 |
| ∟ ∟ abs_path | string | 绝对路径 |
| ∟ ∟ ctime | integer | 创建时间,时间戳,单位为秒 |
| ∟ ∟ ex_dept_id | string | 部门外部id,可以是外部身份源的ID,为空则默认为部门id |
| ∟ ∟ high_light | object | 高亮信息 |
| ∟ ∟ id | string | 部门id,自动生成 |
| ∟ ∟ leaders | objects[] | 部门领导id |
| ∟ ∟ ∟ order | int64 | 排序值 |
| ∟ ∟ ∟ user_id | string | 部门领导user_id |
| ∟ ∟ name | string | 部门名称 |
| ∟ ∟ order | integer | 排序值 |
| ∟ ∟ parent_id | string | 父部门id |
| ∟ next_page_token | string | 下一页token;当查询结果中next_page_token为空或无该返回值时,代表无下一页 |
响应体示例
json
{
"data": {
"items": [
{
"high_light": {
"string": ["string"]
},
"abs_path": "string",
"ctime": 0,
"ex_dept_id": "string",
"id": "string",
"leaders": [
{
"order": 0,
"user_id": "string"
}
],
"name": "string",
"order": 0,
"parent_id": "string"
}
],
"next_page_token": "string"
},
"code": 0,
"detail": "string",
"msg": "string"
}