批量同步部门接口
说明
该接口用于批量更新或保存部门信息。
接口限制
1. 10次/秒;
2. 单次导入限制为200条数据;
3. 单条失败模式。即传入的每条数据互不影响。某条失败，不会影响其他数据执行。
接口地址
/api/openapi/org/department/batch
请求类型
POST
请求参数
参数说明
| 字段名称 | 字段类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| businessCode | String(50) | 是 | 部门编码 |
| newBusinessCode | String(50) | 否 | 新部门编码（替换原编码） |
| name | String(100) | 是 | 部门名称 |
| sortNumber | int | 否 | 排序序号设置限制在（0，10000）之间，不包含0和10000。 填写时，以排序序号降序排列，排序序号越小将优先展示。 不填时，视为不设置该部门排序序号，将在设置排序序号的部门后展示。 |
| managerEmployeeIds | List<String> | 否 | 部门主管工号 |
| parentBizCode | String(50) | 否 | 上级部门编码，不填则挂到根部门下面 |
| controlProperties | List<String> | 否 | 部分部门不能被员工选择场景； reimburse_dept_scene --报销单的承担部门场景下不可以被选； pre_consume_dept_scene --申请单申请部门场景下不可以被选； share_dept_scene --分摊的承担部门场景下不可以被选； loan_dept_scene --借款单的承担部门场景下不可以被选； contract_dept_scene --合同的部门场景下不可以被选； repayment_dept_scene --还款单的责任人部门场景下不可以被选。 不填时视为维持原数据；填写[""]时视为清除原数据 (数组中需要放置一个空字符) 。 |
| enabled | boolean | 否 | 启用状态，默认启用(true)注：如设置为false，则需保证该部门员工列表为空；如设置为false，子部门状态也会变成false。 |
| nameEn | String | 否 | 英文名，不填时视为维持原数据，填写空字符串时视为清除原数据 |
| isCompany | boolean | 否 | 是否是公司，新增操作，不传默认是false，更新操作时，不传表示保持原数据 |
| deptVisibilityType | String | 否 | 限制本部门员工通讯录可见信息类型。 notLimited -- 不限制 ， outerDeptOnlySelf -- 仅可见所在部门及自己 ， outerDeptAndSub -- 仅可见所在部门及下级部门 ， specifyDeptsAndStaffs -- 仅可见指定部门/人 |
| specifyDeptAndUsers | List<SpecifyDeptAndUse> | 否 | 指定部门和员工。 仅在deptVisibilityType为specifyDeptsAndStaffs（仅可见指定部门/人）下必填 |
SpecifyDeptAndUser参数说明
| 字段名称 | 字段类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| type | String(32) | 是 | 指定类型（STAFF -- 员工，DEPARTMENT -- 部门） |
| bizCode | String(50) | 是 | 具体的编码 （当type为STAFF时表示员工工号，当type为DEPARTMENT时表示部门编码） |
参数样例
[
{
"businessCode": "10001.03",
"name": "压力测试03",
"sortNumber": 4,
"managerEmployeeIds": [
"210433"
],
"parentBizCode": " ",
"controlProperties": [
"reimburse_dept_scene",
"pre_consume_dept_scene"
],
"enabled": true,
"nameEn": "dept one",
"isCompany": true,
"deptVisibilityType": "specifyDeptsAndStaffs",
"specifyDeptAndUsers": [
{
"type": "STAFF",
"bizCode": "210433"
}
]
}
]
响应参数
参数样例
- 正常响应参数示例
{ "success":true, "code": "ACK", "message": "保存成功！", "data": null } - 错误返回示例
当有数据发生错误时，code返回NACK，data里会包含错误对象，此接口错误数据的key为部门编码{ "success": false, "code": "NACK", "message": "", "data": { "errorData": [ { "key": "E100011", "errorCode": "110005", "errorMessage": "当前员工常驻地设置只支持一个常驻地" } ] } }errorData中的errorCode说明
部门错误码说明
修改记录
2020-04-02 修改错误返回结果，增加一层
2020-11-09 添加入参 controlProperties 属性，为可选参数
2020-12-01 增加enabled字段
2021-05-27 部分部门不能被员工选择场景增加借款单
2021-10-28 增加sortNumber字段