更新部门接口

修改指定部门的名称、上级部门或外部标识。此接口只更新传入的字段;调整上级部门时,由目录服务校验新的组织层级。

所需权限

所需权限资源Scope资源服务
用户与部门管理(管理)user-directoryadmin.v1.user-directory.manageqwenwork-biz-service

PATCH /api/openapi/v1/departments/{departmentId}

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。

名称位置类型必填说明示例
Authorizationheaderstring应用 API Key,使用 Bearer 方式传递。Bearer qwk_\\*
X-Request-Idheaderstring可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
departmentIdpathstring · uuid必填需要操作的部门标识。"<uuid>"
Idempotency-Keyheaderstring必填本次写操作的幂等键。同一操作重试时复用相同键和请求内容,避免重复处理。"<string>"
external_idbodystring来源系统中的标识,用于关联外部对象。 最多字符数:512。"<string>"
namebodystring部门的名称。 最多字符数:255。"<string>"
parent_idbodystring · uuid上级部门的标识。"<uuid>"

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request PATCH --url '<BASE_URL>/api/openapi/v1/departments/<departmentId>' --header 'Authorization: Bearer <API_KEY>' --header 'Idempotency-Key: <UNIQUE_REQUEST_ID>' --header 'Content-Type: application/json' --data '{  "external_id": "<string>",  "name": "<string>",  "parent_id": "<uuid>"}'

响应

200 请求成功,返回当前或更新后的数据。

名称类型必填说明示例
department_idstring · uuid相关部门的标识。"<uuid>"
external_idstring来源系统中的标识,用于关联外部对象。"<string>"
namestring部门的名称。"<string>"
orderinteger · int64对象在列表中的排序值。0
parent_idstring | null上级部门的标识。"<string>"
{
  "department_id": "<uuid>",
  "external_id": "<string>",
  "name": "<string>",
  "order": 0,
  "parent_id": "<string>"
}

default 请求失败,返回错误码和错误详情。

名称类型必填说明示例
codestring用于程序判断错误原因的稳定业务错误码。"<string>"
detailstring便于阅读的错误说明。"<string>"
detailsOpenapiErrorDetails字段校验失败时的详细信息。{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring未通过校验的请求字段。"<string>"
details.reasonstring稳定的校验失败原因,用于判断字段为何不合法。"<string>"
details.suggestionstring建议采用的规范化字段值。"<string>"
errorstring稳定的 HTTP 错误类型。"<string>"
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}