查询子部门列表
适用版本>=v7.0.2305a.20230511
接口说明:获取子部门列表
请求说明
| 请求地址 | 配置域名+/graph+/v7/depts/{dept_id}/children |
|---|---|
| 请求方法 | GET |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 通讯录查询(企业授权) kso.contacts.read |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间,示例: Wed,23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
路径参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| dept_id | string | 是 | 部门id,字符串长度不超过128位 |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| recursive | boolean | 否 | true: 递归查询子部门 false: 不递归查询子部门 默认为:false |
| page_size | integer | 否 | 分页大小,默认为:10,最大值:50 |
| page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回next_page_token作为新的page_token,下次遍历可采用该page_token获取查询结果 |
| with_total | boolean | 否 | true: 返回总记录数 false: 不返回总记录数 默认为:false |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | 返回信息体 |
| ∟ items | object[] | 部门信息 |
| ∟ ∟ abs_path | string | 绝对路径 |
| ∟ ∟ ctime | integer | 创建时间,时间戳,单位为秒 |
| ∟ ∟ ex_dept_id | string | 部门外部id,可以是外部身份源的ID, |
| ∟ ∟ id | string | 部门id,字符串长度不超过128位 |
| ∟ ∟ name | string | 部门名称,字符串长度不超过128位 |
| ∟ ∟ order | integer | 排序值 |
| ∟ ∟ parent_id | string | 父部门id,字符串长度不超过128位 |
| ∟ ∟ leaders | objects[] | 部门领导id |
| ∟ ∟ ∟ order | int64 | 排序值 |
| ∟ ∟ ∟ user_id | string | 部门领导user_id |
| ∟ next_page_token | string | 下一页token;当查询结果中next_page_token为空或无该返回值时,代表无下一页 |
| ∟ total | integer | 总数 |
响应体示例
{
"code": 0,
"detail": "string",
"msg": "string",
"data": {
"items": [
{
"abs_path": "string",
"ctime": 0,
"ex_dept_id": "string",
"id": "string",
"name": "string",
"order": 0,
"parent_id": "string"
"leaders": [
{
"order": 0,
"user_id": "string"
}
]
}
],
"next_page_token": "string",
"total": 0
}
}