同步人员 - 组织人事

emptyCustomVaueClearable 在2024-1101基线支持后支持

文档中【数据内容】必填仅对新增有效；修改的时候无需考虑必填，
只需要提供：数据规则字段的数据和想要更新字段的数据即可；例如人员规则指定工号，且仅需更新名称，则内容提供job_num和username即可

请求参数

Body 参数application/json

data

array [object {55}]

数据内容

必需

username

string

姓名

必需

新增必填

string

邮箱

可选

superior

string

上级

可选

与【数据规则-人员规则】相关；例如：规则是编号，内容提供编号

mobile

string

手机

可选

other_superior

array[string]

其他上级

可选

与【数据规则-人员规则】相关；例如：规则是编号，内容提供编号

alias

string

别名

可选

telephone

string

电话

可选

sex

string

性别

可选

性别（male、female）

assistant

array[string]

助理

可选

与【字段校验规则-人员规则】相关；例如：规则是编号，内容提供编号

job_num

string

工号

可选

hiredate

string

入职时间

可选

（格式：2019-08-20）

department

string

所属组织

必需

新增必填；可以是部门，也可以是分部；与【数据规则-组织规则】相关；例如：规则是编号，内容提供编号

position

string

岗位

可选

与【数据规则-岗位规则】相关；例如：规则是编号，内容提供编号

job_call

string

职称

可选

grade

string

职级

可选

与【数据规则-职级规则】相关；例如：规则是编号，内容提供编号

location

string

办公地点

可选

仅支持id

personnel_status

string

状态

必需

1:试用；2:试用延期；3:正式；4:临时;5:实习;6:离职;7:退休

id_no

string

身份证

可选

birthday

string

出生日期

可选

（格式：2019-08-20）

age

string

年龄

可选

graduate_date

string

毕业日期

可选

（格式：2019-08-20）

graduate_school

string

毕业院校

可选

degree

string

学位

可选

学位：博士,硕士,学士

education

string

学历

可选

学历：高中及以下，中技（中专/技校/职高），大专，本科，硕士研究生，博士研究生，MBA

marital_status

string

婚姻状况

可选

married:已婚,unmarried:未婚,divorced:离异

native_place

string

籍贯

可选

nation

string

民族

可选

民族(汉族，壮族等)

household_type

string

户口类型

可选

本市城镇，本市农村，外埠城镇，外埠农村

politics_status

string

政治面貌

可选

政治面貌：党员（含预备党员），团员，民主党派，无党派人士（群众），其他

residence_place

string

现居住地

可选

family_contact

string

家庭联系方式

可选

first_work_date

string

首次参加工作日期

可选

（格式：2019-08-20）

work_year

string

个人工龄（年）

可选

child_status

string

子女状态

可选

string

人员id

可选

当【数据规则-人员规则】为id的时候；修改人员需要提供，其他不需要

account

string

账号

可选

该字段仅可以传递手机号码或者邮箱

账号只能为手机邮箱格式，如果需要导入其他格式，需要进入主管团队，在后台管理中心-基本设置-系统级设置-账号安全类里面，开启【账号不强校验手机邮箱格式】；如果是海外手机号，需要在区位码前需要添加“+”号。

loginMobile

string

登录手机

可选

240401基线后支持

loginEmail

string

登录邮箱

可选

240401基线后支持

loginid

string

登录名

可选

【后台管理中心-账号安全-安全设置】登录设置-账号支持方式：登录名开启才支持；可以修改

password

string

密码

可选

不支持修改密码场景：已经登录过，其他租户使用此账号等

不提供密码（账号安全-密码策略-启用初始密码）：开启后，会使用默认密码规则

情况1可以采用开关放行：
主管团队管理员在【基本设置-系统级设置-人员同步账号校验规则】开启已存在用户且用户已登录不允许修改密码

login_status

string

登录状态

可选

提供，normal 表示激活；默认新建人员未激活

employeeExtend

object

基本信息自定义字段

可选

基本信息自定义字段；传值说明：https://open-doc.eteams.cn/web/#/1?page_id=78

在2504版本后支持传入数据key（可以自定义表单设计器中看到字段的数据key内容）

userInfoExtend

object

自定义表单

可选

个人信息自定义字段【https://open-doc.eteams.cn/web/#/1?page_id=209】；传值说明：https://open-doc.eteams.cn/web/#/1?page_id=78

在2504版本后支持传入数据key（可以自定义表单设计器中看到字段的数据key内容）

resourceimageid

number

照片头像

可选

照片头像;必须是文档资源的id;

先通过文件上传接口上传头像，获取到的文档id，放到这个参数里面

文档上传-开放平台接口地址： https://weapp.eteams.cn/sp/opendoc/freepass/10.0.2411.01/zh_cn/840720770038071297

sec_level

integer

安全级别

可选

classification

string

密级

可选

belongto

string

主账号

可选

提供主账号内容；内容与规则中employee规则一致，比如规则中指定工号（job_num）,则内容提供工号

multiObj

object

多语言

可选

dsporder

number

显示排序

可选

accounttype

string

账号类型

可选

0 主账号；1 次账号。如果是次账号，需要额外提供 belongto

resp_desc

string

职责描述

可选

office

string

办公室

可选

fax

string

传真

可选

jobset_level

string

职等

可选

仅支持提供id

leavedate

string

离职日期

可选

在250601基线后支持；
仅当人员从在职变成离职，才有效；

；例如： personnel_status=6 （离职）表示当前要离职，同时OA中人员是3 （正式）；则离职日期可以维护卡片上

dataRule

object

数据规则

必需

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

employee

string

人员规则

必需

id: 按照人员id来检查;username：按照名称检查；job_num: 按照工号来检查；

department

string

组织（含分部、部门）规则

必需

id:按照组织id来检查；name:按照组织名称来检查；code:按照组织编号来检查

position

string

岗位规则

可选

id:按照岗位id来检查；name：按照岗位名称来检查；code:按照岗位编码来检查

grade

string

职级规则

可选

id:按照职级id来检查；name：按照职级名称来检查；code:按照职级编号来检查

pwdTransType

string

密码传输加密规则

可选

0901基线后支持： sm4 表示采用sm4加密（秘钥需要在hrm_config_set表中插入对应租户一条数据：config_code=pwdTransEncryptKey, config_value即为秘钥）；默认是明文传输

apiTaskId

string

任务号

可选

任务号，相同任务号防止并发； 0701基线支持

optId

string

操作者

可选

emptyCustomVaueClearable

boolean

自定义字段内容清空标识

可选

自定义字段的内容是否允许清空

extKey

string

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

可选

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

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

示例

{
    "data": [
        {
            "department": "5493376151437312",
            "position":"1493376151437316",
            "job_num":"WS001",
            "username": "冰冰",
            "alias":"阿满",
            "email":"1122@email.com",
            "mobile":"17317576779",
            "telephone":"6058",
            "sex":"male",
            "hiredate":"2023-01-01",
            "id_no":"342401158804061678",
            "superior":"972098004390019071",
            "other_superior":["972098004390019076","972098004390019072"],
            "birthday":"1911-02-05",
            "age":"16",
            "graduate_school":"安徽科技学院",
            "graduate_date":"1992-02-01",
            "degree":"博士",
            "education":"大专",
            "personnel_status":"3",
            "job_call":"972098004390019075",
            "grade":"172098004390019071",
            "marital_status":"divorced",
            "native_place":"安徽省",
            "nation":"汉族",
            "household_type":"本市农村",
            "politics_status":"团员",
            "residence_place":"上海市",
            "family_contact":"021",
            "first_work_date":"2022-01-01",
            "work_year":3,
            "child_status":"2个儿子",
            "userInfoExtend":{
                "766265897162719232":"单行文本a",
                "766265965832413188":["测试兼职检查-212","安全级别"],
                "766265965832413189":["5495890441397212937"]
            },
            "employeeExtend":{
                "dhwb":"1122",
                "drl":["张三"]
            },
            "multiObj":{
                "username":{
                    "8":"dailishangd",
                    "9":"代理商-繁体"
                }
            }
        }
    ],
    "dataRule": {
        "employee": "username",
        "department":"id"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/hrm/restful/syncEmployee' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "department": "5493376151437312",
            "position":"1493376151437316",
            "job_num":"WS001",
            "username": "冰冰",
            "alias":"阿满",
            "email":"1122@email.com",
            "mobile":"17317576779",
            "telephone":"6058",
            "sex":"male",
            "hiredate":"2023-01-01",
            "id_no":"342401158804061678",
            "superior":"972098004390019071",
            "other_superior":["972098004390019076","972098004390019072"],
            "birthday":"1911-02-05",
            "age":"16",
            "graduate_school":"安徽科技学院",
            "graduate_date":"1992-02-01",
            "degree":"博士",
            "education":"大专",
            "personnel_status":"3",
            "job_call":"972098004390019075",
            "grade":"172098004390019071",
            "marital_status":"divorced",
            "native_place":"安徽省",
            "nation":"汉族",
            "household_type":"本市农村",
            "politics_status":"团员",
            "residence_place":"上海市",
            "family_contact":"021",
            "first_work_date":"2022-01-01",
            "work_year":3,
            "child_status":"2个儿子",
            "userInfoExtend":{
                "766265897162719232":"单行文本a",
                "766265965832413188":["测试兼职检查-212","安全级别"],
                "766265965832413189":["5495890441397212937"]
            },
            "employeeExtend":{
                "dhwb":"1122",
                "drl":["张三"]
            },
            "multiObj":{
                "username":{
                    "8":"dailishangd",
                    "9":"代理商-繁体"
                }
            }
        }
    ],
    "dataRule": {
        "employee": "username",
        "department":"id"
    }
}'

返回响应

🟢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": "接布议阶五",
            "operate": "UPDATE",
            "status": "ERROR",
            "errcode": "组织 未找到：711513701328371713",
            "needRepush": false
        }
    ]
}