批量同步接口

  • 接口:common/projects/batch
  • Method:POST
  • 数据格式:JSON
  • 限流信息:100次每天和50次每小时
  • 多语言环境:在接口请求头中添加Key为locale,Value值为语言环境,目前支持的语言有zh_CN(中文)、en_US(英文)、ja_JP(日文)、zh_TW(繁体),请选取其中一种
  • 接口说明:该接口用作项目的批量同步,在整批数据中如果只有几条数据因为其他原因失败,那么只有这几条数据不会被处理,其他数据仍会被正常处理
  • 其他补充信息:单次数据量过大时候(超过200条)会全部转为异步处理,具体参考回调示例

参数:

请求参数

字段名称 字段类型 字段描述 是否必填 长度限制(字节)
bizId String 当前次接口同步的唯一标识 TRUE 36
timestamp long 当前次接口同步对应的时间戳 TRUE 13
data Array 当前次接口同步的数据集合 TRUE
data.code String 项目编码 TRUE 64
data.project_name String 项目名称 TRUE 255
data.project_owner String 项目员工主管号 FALSE 64
data.project_department String 项目所属部门代码 FALSE 64
data.description String 项目描述 FALSE 255
data.enabled_flag String 是否启用标志(Y/N,默认为Y) FALSE 1
data.staff_flag String 员工权限是否启用标志(Y/N,默认为N) FALSE 1
data.project_status String 项目状态(complete完成,incomplete未完成) FALSE 16
data.branch_flag String 是否保留之前分公司标志(Y/N 默认为Y) FALSE 1
data.branch_codes String 项目所属分公司集合对应的编码数组 FALSE
data.parent_code String 父项目编码 FALSE 64
column1-column50 String column字段信息 FALSE 255

返回参数

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

示例:

请求数据

{
  "bizId" : "6f323de6-a827-415f-9cc5-b0b0c606026c",
  "timestamp" : 1591260811573,
  "data" : [ {
    "column1" : "column1",
    "code" : "project001",
    "parent_code" : "project000",
    "project_name" : "projectName001",
    "project_owner" : "E000517",
    "project_department" : "D002",
    "description" : "project001的描述",
    "enabled_flag" : "Y",
    "project_status" : "complete",
    "branch_flag" : "Y",
    "branch_codes" : [ "Company001", "Company002" ]
  }, {
    "column1" : "column1",
    "code" : "",
    "parent_code" : "",
    "project_name" : "projectName002",
    "project_owner" : "",
    "project_department" : "D002",
    "description" : "project002的描述",
    "enabled_flag" : "Y",
    "project_status" : "complete",
    "branch_flag" : "M",
    "branch_codes" : [ "Company001", "Company002" ]
  }, {
    "column1" : "column1",
    "code" : "project003",
    "parent_code" : "project002",
    "project_name" : "projectName003",
    "project_owner" : "E00071900",
    "project_department" : "D00200",
    "description" : "project003的描述",
    "enabled_flag" : "Y",
    "project_status" : "incomplete",
    "branch_flag" : "Y",
    "branch_codes" : [ "Company00100", "Company00200" ]
  } ]
}

返回数据

{
  "resCode" : 200000,
  "resMsg" : "success",
  "bizId" : "6f323de6-a827-415f-9cc5-b0b0c606026c",
  "data" : {
    "validatorErrors" : [ {
      "code" : "",
      "messages" : [ "请输入Y/N或者使用默认值", "编码不能为空" ]
    }, {
      "code" : "E00071900",
      "messages" : [ "项目主管员工号E00071900不存在" ]
    } ],
    "created" : "此次请求新建成功了0条数据",
    "warnings" : [ ],
    "dbErrors" : [ {
      "code" : "project001",
      "messages" : [ "上级编码project000不存在" ]
    } ],
    "updated" : "此次请求更新成功了0条数据"
  }
}

results matching ""

    No results matching ""