同步外部部门 - 组织人事

请求参数

Body 参数application/json

data

array [object {6}]

必需

name

string

部门名称

必需

fullname

string

部门全称

可选

disporder

number

显示顺序

可选

description

string

备注

可选

parent

string

上级部门

可选

上级部门，如果无上级部门，可以空，但是所属企业需要有值

数据内容与数据规则-部门规则有关系

比如部门规则是id，则提供id；部门规则是名称，则提供名称

subcompanyid

string

所属企业

必需

所属企业，新增的时候必须提供；

内容与数据规则-企业规则有关

比如企业规则是id，则提供id；企业规则是名称，则提供名称

dataRule

object

数据规则

必需

字段校验规则；比如指定人员规则是名称，就按照名称规则检查唯一，如果查询到则更新；否则新增

department

string

部门规则

可选

id:按照部门id来检查；name:按照部门名称来检查；

subcompany

string

企业规则

可选

id:按照企业id来检查；name:按照企业名称来检查；

apiTaskId

string

任务号

可选

任务号，相同任务号防止并发

optId

string

操作者

必需

会更新到邀请人里面；

extKey

string

指定需要额外返回内容的key

可选

指定报文中某个列，需要在返回报文中返回；
当指定后，返回内容将提供：extKeyMap；是map对象，并返回指定的key和其内容；

例如指定 extkey=uuid，且报文提供了uuid=1234;则返回内容有
"extKeyMap": {
"uuid": "1234"
}

virtualId

number

维度id

必需

外部联系人维度id;

1.

外部互联-维度管理中看到
或者

2.

使用下面sql查询： select * from hrm_company_virtual hcv where tenant_key =租户key and data_type in ('extenal','lower_external','wechat_external','custom_external')

示例

{
    "access_token": "00098fd529fc19d258d4a25087167618",
    "data": [
        {
            "name": "经理室",
            "fullname": "经理室full",
            "parent":"人事部",
            "subcompanyid":"外部泛微",
            "disporder": 5,
            "description": "描述"
        }
    ],
    "dataRule": {
        "subcompany": "name",
        "department": "name"
    },
    "apiTaskId": "task1",
    "optId": "1040027954357846017",
    "extKey": "outkey",
    "virtualId": "900030746512072704"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/hrm/restful/syncExternalDepartment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "access_token": "00098fd529fc19d258d4a25087167618",
    "data": [
        {
            "name": "经理室",
            "fullname": "经理室full",
            "parent":"人事部",
            "subcompanyid":"外部泛微",
            "disporder": 5,
            "description": "描述"
        }
    ],
    "dataRule": {
        "subcompany": "name",
        "department": "name"
    },
    "apiTaskId": "task1",
    "optId": "1040027954357846017",
    "extKey": "outkey",
    "virtualId": "900030746512072704"
}'

返回响应

🟢200成功

application/json

Body

code

integer

api状态

必需

200 成功

msg

string

描述

必需

status

boolean

状态

必需

false 失败；true 成功

data

array [object {5}]

必需

keyValue

string

数据唯一字段值

可选

operate

string

同步操作类型

可选

add 新增、update 修改

status

string

状态

可选

SUCCESS 成功；ERROR 失败

errcode

string

失败原因

可选

needRepush

boolean

可选

示例

{"message":{"errcode":"0","errmsg":"success"},"data":[{"keyValue":"经理室","id":8513466224574465,"operate":"ADD","status":"SUCCESS","errcode":"SUCCESS","needRepush":false}]}