更新部门
查看文档来源信息
- 来源目录:
addons/sys_base/docs - 来源文件:
接口文档/42-更新部门.md
详细说明
用于更新部门基础信息,并校验可用于生成用户编号的部门编码。
接口信息
| 项目 | 内容 |
|---|---|
| 请求方式 | PUT |
| 请求路径 | /sys_base/platform/organization/updateOrganization |
| 来源文件 | 接口文档/42-更新部门.md |
请求头
| 请求头 | 示例值 | 说明 |
|---|---|---|
Content-Type | application/json | 请求体格式。 |
x-token | <登录令牌> | 登录令牌。 |
app-id | mid-admin | 当前应用 ID。 |
addons-type | sys_base | 当前模块标识。 |
入参
| 参数名 | 类型 | 是否必填 | 示例值 | 参数说明 |
|---|---|---|---|---|
ID | number | 是 | 2001 | 部门 ID |
name | string | 是 | 结算中心 | 部门名称 |
orgFlag | string | 是 | JS | 部门编码,1 到 8 位大写英文字母或数字,必须以字母开头,部门之间唯一 |
parentID | number | 否 | 0 | 上级部门 ID,不能设置为自身或自身子部门 |
sort | number | 否 | 10 | 排序值 |
isEnable | boolean | 否 | true | 是否启用 |
参数说明
ID:要更新的部门 ID。name:部门名称。orgFlag:部门编码,后端会转为大写保存,并作为用户编号publicId的前缀。parentID:上级部门 ID。sort:排序值。isEnable:是否启用部门。orgFlag不允许为空、不允许重复、不允许使用超过 8 位的历史兼容编码。
请求示例
json
{
"ID": 2001,
"name": "结算中心",
"orgFlag": "JS",
"parentID": 0,
"sort": 10,
"isEnable": true
}响应输出
json
{
"code": 1000,
"msg": "操作成功",
"data": {
"success": true,
"id": 1
}
}字段说明
| 字段名 | 类型 | 示例值 | 字段说明 |
|---|---|---|---|
code | number | 1000 | 业务状态码 |
msg | string | 操作成功 | 返回消息 |
data.success | boolean | true | 操作结果 |
data.id | number | 1 | 受影响记录 ID |
curl 示例
bash
curl --location --request PUT 'http://127.0.0.1:8100/sys_base/platform/organization/updateOrganization' \
--header 'Content-Type: application/json' \
--header 'x-token: <登录令牌>' \
--header 'app-id: mid-admin' \
--header 'addons-type: sys_base' \
--data-raw '{
"ID": 2001,
"name": "结算中心",
"orgFlag": "JS",
"parentID": 0,
"sort": 10,
"isEnable": true
}'