查询子部门列表
基于 dept_id 查询获取部门的子部门列表
请求说明
请求地址 | https://openapi.wps.cn/v7/depts/{dept_id}/children |
---|---|
请求方法 | GET |
签名方式 | KSO-1 |
权限要求 | 查询和管理通讯录信息(应用授权) kso.contact.readwrite 查询通讯录信息(应用授权) kso.contact.read |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
名称 | 参数类型 | 说明 |
---|---|---|
dept_id | string | 部门 id |
查询参数(Query)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
page_size | integer | 否 | 分页大小,默认为:10,最大值:50 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 |
with_total | boolean | 否 | 是否返回 total 总数字段 |
请求地址示例
[GET] https://openapi.wps.cn/v7/depts/{dept_id}/children?page_size={integer}&page_token={string}&with_total={boolean}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ items | array[object] | 子部门列表 |
∟ ∟ abs_path | string | 绝对路径 |
∟ ∟ ctime | integer | 创建时间 |
∟ ∟ ex_dept_id | string | 部门外部 id,可以是外部身份源的 id,为空则默认为部门 id |
∟ ∟ id | string | 部门 id |
∟ ∟ leaders | array[object] | 部门领导 |
∟ ∟ ∟ order | integer | 排序值 |
∟ ∟ ∟ user_id | string | 部门领导 user_id |
∟ ∟ name | string | 部门名称 |
∟ ∟ order | integer | 排序值 |
∟ ∟ parent_id | string | 父部门 id |
∟ next_page_token | string | 下一页 token |
∟ total | integer | 总数,当 query 的 with_total=true 时返回 |
响应体示例
json
{
"data": {
"items": [
{
"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",
"total": 0
},
"msg": "string",
"code": 0
}