部门同步
一、接口URL
/department/on/official?token=xxxxxxxxxxxxx
二、功能
组织部门同步(*注: 07:00-23:59时段同步阀值10000次/天,超出返回错误;00:00-06:59时段不做阀值限制)
三、请求参数
名称 | 类型 | 是否必传 | 传参方式 | 说明 |
---|---|---|---|---|
token | string | true | RequestParam | 访问的key |
Operate | String | true | RequestBody | 同步动作,候选值:"new": 新建部门 "delete": 部门删除 "move": 部门移动或者改名 "update": 修改部门排序 |
parentNames | Array | true | RequestBody | 父部门名称,全路径字符串数组; "Operate"字段为"new","delete","update"时有效, 必填; 如: 研发部/服务器组,格式为:["研发部","服务器组"]; []是根部门。 |
name | String | true | RequestBody | 部门名称,"Operate"字段为"new","delete","update"时有效;必填。 |
orderFlag | Int | false | RequestBody | 排序值, "Operate"字段为"new","update"时有效;非必填。 |
oldNames | Array | false | RequestBody | 旧部门名称,字符串数组; 格式同"name"字段; "Operate"字段为"move"时有效,表示被改名或者移动的部门旧名称。 |
newNames | Array | false | RequestBody | 新部门名称,字符串数组; 格式同"name"字段; "Operate"字段为"move"时有效,表示被改名或者移动的部门新名称。 |
四、请求体
1.新建部门:
{ "Operate": "new", "parentNames": ["研发部",], "name": "服务器组"}
2.删除部门:
{ "Operate": "delete", "parentNames": ["研发部",], "name": "服务器组"}
3.部门改名, "研发部/服务器组" 改名为 "研发部/后台任务组":
{ "Operate": "move", "oldNames": ["研发部","服务器组"], "newNames": ["研发部","后台工作组"]}
4.部门移动, "研发部/服务器组" 移动到 "研发二部":
{ "Operate": "move", "oldNames": ["研发部","服务器组"], "parentNames": ["研发二部","服务器组"]}
五、返回参数
名称 | 类型 | 说明 |
---|---|---|
errorCode | Integer | 结果码,0: 成功, 非0:失败(具体描述见错误码表) |
errorMessage | String | 错误描述 |
requestId | String | 请求唯一ID。 |
六、返回体
{ "errorCode": 0, "errorMessage": "success", "requestId": "openapi-ums-165-17e9061a-adc5-4392-b160-0305fb65a0f5"}
七、备注
1.删除部门时, 此部门必须没有用户,也没有子部门。
2.部门改名、移动时,新部门的名称的父部门必须存在。