同步虚拟维度人员

请求参数

Body 参数application/json

data

array [object {3}]

必需

employeeid

string

人员

必需

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

superior

string

上级

可选

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

orgid

string

组织

必需

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

dataRule

object

数据规则

必需

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

organization

string

组织规则

必需

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

employee

string

人员规则

必需

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

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 ('custom')

示例

{
    "data": [
        {
            "employeeid": "普通人员gecy",
            "orgid": "证券事务与法务部",
            "outkey":"11234"
        }
    ],
    "dataRule": {
        "organization": "name",
        "employee": "username"
    },
    "apiTaskId": "task1",
    "optId": "1043329525724610576",
    "extKey": "outkey",
    "virtualId": "1105610696280399875"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/hrm/restful/syncVirtualEmployee' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "employeeid": "普通人员gecy",
            "orgid": "证券事务与法务部",
            "outkey":"11234"
        }
    ],
    "dataRule": {
        "organization": "name",
        "employee": "username"
    },
    "apiTaskId": "task1",
    "optId": "1043329525724610576",
    "extKey": "outkey",
    "virtualId": "1105610696280399875"
}'

返回响应

🟢200成功

application/json

Body

message

object

必需

errcode

string

必需

errmsg

string

必需

data

array [object {7}]

必需

keyValue

string

数据唯一字段值

可选

id

integer

可选

operate

string

同步操作类型

可选

add 新增、update 修改

status

string

状态

可选

SUCCESS 成功；ERROR 失败

errcode

string

失败原因

可选

needRepush

boolean

可选

extKeyMap

object

可选

示例

{"message":{"errcode":"0","errmsg":"success"},"data":[{"keyValue":"null","id":1108677607767982080,"operate":"ADD","status":"SUCCESS","errcode":"SUCCESS","needRepush":false,"extKeyMap":{"outkey":"11234"}}]}