获取部门树
查看文档来源信息
- 来源目录:
addons/sys_base/docs - 来源文件:
接口文档/37-获取部门树.md
详细说明
用于获取当前操作者在中间件内可见的部门树,返回结果按“系统超级管理员 / 部门管理员 / 普通部门用户”三档规则判定。
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | POST |
| 请求路径 | /sys_base/platform/organization/getOrgTreeList |
| 来源文件 | 接口文档/37-获取部门树.md |
请求头
| 请求头 | 示例值 | 说明 |
|---|---|---|
Content-Type | application/json | 请求体格式。 |
x-token | <登录令牌> | 登录令牌。 |
app-id | mid-admin | 当前应用 ID。 |
addons-type | sys_base | 当前模块标识。 |
入参
| 参数名 | 类型 | 是否必填 | 示例值 | 参数说明 |
|---|---|---|---|---|
name | string | 否 | 总部 | 部门名称关键字,按正式可见范围过滤 |
isEnable | boolean | 否 | true | 是否只看指定启用状态 |
参数说明
name:模糊匹配部门名称。isEnable:仅在部门树页使用,控制是否返回启用或停用部门。
请求示例
json
{
"name": "总部",
"isEnable": true
}响应输出
json
{
"code": 0,
"msg": "成功",
"data": {
"result": [
{
"ID": 243,
"name": "超级管理员",
"orgFlag": "admin",
"parentID": 0,
"isEnable": true,
"children": []
}
]
}
}字段说明
| 字段名 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|
code | number | 0 | 业务状态码 |
msg | string | 成功 | 返回消息 |
data.result | array | [...] | 部门树根节点列表 |
data.result[].ID | number | 243 | 部门主键 ID |
data.result[].name | string | 超级管理员 | 部门名称 |
data.result[].orgFlag | string | admin | 部门标识 |
data.result[].parentID | number | 0 | 父部门 ID |
data.result[].isEnable | boolean | true | 是否启用 |
data.result[].children | array | [] | 子部门列表 |
curl 示例
bash
curl --location --request POST 'http://127.0.0.1:8100/sys_base/platform/organization/getOrgTreeList' \
--header 'Content-Type: application/json' \
--header 'x-token: <登录令牌>' \
--header 'app-id: mid-admin' \
--header 'addons-type: sys_base' \
--data-raw '{
"name": "总部",
"isEnable": true
}'