批量同步接口

  • 接口：common/externalPersons/batch
  • Method：POST
  • 数据格式：JSON
  • 限流信息：150次每天和50次每小时
  • 多语言环境：在接口请求头中添加Key为locale,Value值为语言环境,目前支持的语言有zh_CN(中文)、en_US(英文)、ja_JP(日文)、zh_TW(繁体),请选取其中一种
  • 接口说明：该接口用作外部人员信息的批量同步(根据code是否存在判断新增/更新)，在整批数据中如果只有几条数据因为其他原因失败，那么只有这几条数据不会被处理，其他数据仍会被正常处理
  • 其他补充信息：该接口用作外部人员信息的批量同步(根据code是否存在判断新增/更新)，在整批数据中如果只有几条数据因为其他原因失败，那么只有这几条数据不会被处理，其他数据仍会被正常处理

    参数:

请求参数

字段名称 字段类型 字段描述 是否必填 长度限制(字节)
bizId String 当前次接口同步的唯一标识 TRUE 36
timestamp long 当前次接口同步对应的时间戳 TRUE 13
data Array 当前次接口同步的数据集合 TRUE 无
data.code String 外部人员代码 TRUE 64
data.type_code String 外部人员类型代码 TRUE 64
data.full_name String 外部人员全名 TRUE 255
data.email_address String 用户电子邮箱地址 FALSE 255
data.level_code String 级别 FALSE 64
data.mobile String 手机号 FALSE 64
data.enabled_flag String 启用标志(Y/N,默认为Y) FALSE 1
data.gender String 性别(M/F) FALSE 16
data.birthday Date 生日(格式 yyyy-MM-dd HH:DD:ss) FALSE 0
data.surname String 姓 FALSE 255
data.given_name String 名 FALSE 255
data.nationality String 国籍 FALSE 64
data.description String 描述 FALSE 64
data.attribute1 String column字段信息 FALSE 255
data.attribute2 String column字段信息 FALSE 255
data.attribute3 String column字段信息 FALSE 255
data.attribute4 String column字段信息 FALSE 255
data.attribute5 String column字段信息 FALSE 255
data.column1-data.column50 String column字段信息 FALSE 255

返回参数

字段名称 字段类型 字段描述
bizId String 当前次接口同步的唯一标识
resCode Integer 响应状态码（见附录）
resMsg String 返回信息描述
created String 创建成功的条数
updated String 更新成功的条数
validatorErrors Array 字段强校验不合格的数据
dbErrors Array 数据持久化时出现错误的数据
warnings Array 字段弱校验不合格的数据，任会做同步处理

示例：

请求数据

{
  "bizId": "4e13e967-50c3-40a3-bde2-7b4aa164ece7",
  "timestamp": 1594017230978,
  "data": [
    {
      "code": "6222605",
      "type_code": "JZ",
      "level_code": "123212",
      "email_address": "E0005174@123",
      "mobile": "12334213212",
      "full_name": "全名",
      "gender": "M",
      "column1": 1.1,
      "column5": "D1",
      "attritube4": "83901"
    }
  ]
}

返回数据

{
  "resCode" : 200000,
  "resMsg" : "success",
  "bizId" : "d162175f-5bdf-43c8-a245-a013dc219ffd",
  "data" : {
    "validatorErrors" : [],
    "created" : "此次请求新建成功了0条数据",
    "warnings" : [],
    "dbErrors" : [],
    "updated" : "此次请求更新成功了1条数据"
  }
}

results matching ""

    No results matching ""