同步条件矩阵数据

请求参数

Cookie 参数

ETEAMSID

string

可选

默认值:

PCACCOUNT_c0e81dfa2f0a1ccf1971836b809a5135-BF90B6HP342K4

Body 参数application/json

matrixName

string

矩阵名称

必需

dataList

array [object {3}]

矩阵数据

必需

dataId

string

行id

可选

唯一确认矩阵某一行数据的id值

1.

如果是系统矩阵、或者同步矩阵，则行id就是部门或者分部的id，同时支持数据规则

2.

如果需要更新数据，则行id是必须的；新增数据不需要

delete_type

integer

删除标识

可选

仅支持 1 ：表示需要删除；需要与行id配合使用，确认删除某一行数据；仅支持自定义矩阵

[矩阵列名称]

string

矩阵列数据

可选

其中[矩阵列名称] 替换成具体矩阵中的列名称；值提供想要同步的值；
例如： {
dataId:"1112233",
"部门负责人":["张三","王五"]
}

规则：

1.

如果提供空字符串，则清空数据。如果不想更新或者新增数据是空数据，则可以不提供这个矩阵列

2.

多个值：如果是多个值，可以提供数组，或者以英文逗号分隔的字符串

optId

string

操作者

必需

OA中人员id; 如果实在没有，可以提供-1

taskId

string

当前请求任务号

可选

尽量唯一，防止并发

extKeyField

string

外键字段

可选

指定后，返回报文中extKeyMap，将提供对应的信息（内容与请求报文一致）；主要目的是让第三方系统方便绑定矩阵行id，下次同步可以根据行id更新数据；

备注：不允许与矩阵列相同，会导致矩阵列不进行更新。

dataRule

object

数据规则

必需

仅支持人员规则、部门规则、分部规则；其他只能用id同步

employee

string

人员规则

必需

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

employeeScopeConfig

string

人员范围配置

可选

人员查询范围，默认包含主次账号、在职离职人员；
提供 onlyMainAccount ：仅主账号
提供 onlyNormal: 仅在职人员

多个值，以英文逗号分隔

基线支持： 1101基线及其以上

department

string

部门规则

可选

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

subcompany

string

分部规则

可选

id:按照分部id来检查；name:按照分部名称来检查；code:按照分部编号来检查

示例

{
  "matrixName": "自定义矩阵",
  "dataList": [
    {
      "分部": "非混编转混编团队A",
      "负责人": [
        "张三",
        "李四"
      ],
      "分管领导": "张三",
      "outkey": "xxxxxxx001"
    }
  ],
  "optId": "1054142604262465545",
  "taskId": "33",
  "extKeyField": "outkey",
  "dataRule": {
    "employee": "username",
    "subcompany": "name"
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/hrm/restful/syncMatrixData' \
--header 'Cookie: ETEAMSID=PCACCOUNT_c0e81dfa2f0a1ccf1971836b809a5135-BF90B6HP342K4' \
--header 'Content-Type: application/json' \
--data-raw '{
    "matrixName": "自定义矩阵",
    "dataList": [
        {
            "分部":"非混编转混编团队A",
            "负责人":["张三","李四"],
            "分管领导":"张三",
             "outkey":"xxxxxxx001"
        }
    ],
    "optId": "1054142604262465545",
    "taskId": "33",
    "extKeyField": "outkey",
    "dataRule": {
        "employee":"username",
        "subcompany":"name"
    }
}'

返回响应

🟢200成功

application/json

Body

message

object

可选

errcode

string

接口状态

可选

0 成功，其他异常

errmsg

string

接口说明

可选

success 成功；其他异常

data

array [object {5}]

必需

keyValue

string

行id

可选

矩阵的行id，唯一定位一条数据

id

number

行id

可选

long类型，可能丢失精度，建议使用 keyValue

operate

string

操作

可选

ADD 新增；UPDATE 修改； REMOVE 删除

status

string

状态

可选

SUCCESS 成功

extKeyMap

object

外键数据

可选

根据入参中指定的外键字段；从请求报文中返回数据，方便第三方系统绑定数据

示例

新增成功示例修改成功

{
  "message": {
    "errcode": "0",
    "errmsg": "success"
  },
  "data": [
    {
      "keyValue": "1055317737314205696",
      "id": 1055317737314205700,
      "operate": "ADD",
      "status": "SUCCESS",
      "needRepush": false,
      "extKeyMap": {
        "outkey": "xxxxxxx001"
      }
    }
  ]
}