批量创建多个相互独立的部门。批量条目之间不支持父子依赖,需要建多层树时按层分批调用。
departments:write
POST{域名}/openapi/v1/departments/batch-createcode=0 仅表示请求处理完成,不代表所有部门均成功创建,需根据 success_items 和 failed_items 判断逐项结果。| Header 参数 | 是否必填 | 描述 |
|---|---|---|
Authorization |
是 | 固定取值为 Bearer {access_token}。关于如何获取访问令牌,参考鉴权。 |
Content-Type |
是 | 固定取值为 application/json。 |
| 参数 | 类型 | 是否必填 | 默认值 | 描述 |
|---|---|---|---|---|
departments |
array | 是 | - | 待创建部门。范围为 1 至 100 个。 |
|
|
string |
是 |
- |
新部门直属的父部门的 ID。 传 部门 ID 可以通过 “获取单个父部门的子部门” 接口或 ”按关键词搜索部门“ 接口获取。 |
|
|
string |
是 |
- |
新部门的名称。 去除首尾空白后不能为空,最多 30 个 Unicode 字符,同一父部门下不可重复。 |
该接口独有的响应参数如下,参数位于 data 中。通用响应参数参考此文档。
| 参数 | 类型 | 描述 |
|---|---|---|
success_count |
int | 创建成功的部门数量。 |
success_items |
array | 创建成功的条目。 |
success_items[].index |
int | 创建成功的新部门在请求中传入的 departments 数组中的下标,从 0 开始。 |
success_items[].department_id |
string | 创建成功的新部门的 ID。 |
failed_items |
array | 创建失败的条目。 |
failed_items[].index |
int | 创建失败的部门在请求中传入的 departments 数组中的下标,从 0 开始。 |
failed_items[].code |
int | 错误码。 |
failed_items[].message |
string | 失败原因。 |
curl -X POST "${HOST}/openapi/v1/departments/batch-create" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"departments": [
{
"parent_department_id": "0",
"name": "研发一部"
},
{
"parent_department_id": "0",
"name": "研发二部"
}
]
}'
以下示例假设企业根部门下已存在名为 “研发二部” 的部门,因此第 0 项创建成功,第 1 项因名称重复创建失败。
{
"code": 0,
"message": "success",
"request_id": "req_xxx",
"data": {
"success_count": 1,
"success_items": [
{
"index": 0,
"department_id": "30001"
}
],
"failed_items": [
{
"index": 1,
"code": 30101,
"message": "department name duplicate"
}
]
}
}
若该接口的请求返回错误码,参考错误码文档进行排查。