批量同步接口
- 接口:common/lovs/batch
- Method:POST
- 数据格式:JSON
- 限流信息:150次每天和30次每小时
- 多语言环境:在接口请求头中添加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.value |
String |
主数据类型下的基础数据名称 |
TRUE |
64 |
data.description |
String |
主数据类型下的基础数据描述 |
FALSE |
255 |
data.enabled_flag |
String |
启用标志(Y/N,默认为Y) |
FALSE |
1 |
data.type |
String |
主数据类型下的基础代码 |
TRUE |
64 |
data.column25 |
String |
column1-50字段 |
FALSE |
255 |
返回参数
字段名称 |
字段类型 |
字段描述 |
bizId |
String |
当前次接口同步的唯一标识 |
resCode |
Integer |
响应状态码(见附录) |
resMsg |
String |
返回信息描述 |
created |
String |
创建成功的条数 |
updated |
String |
更新成功的条数 |
validatorErrors |
Array |
字段强校验不合格的数据 |
dbErrors |
Array |
数据持久化时出现错误的数据 |
warnings |
Array |
字段弱校验不合格的数据,仍会做同步处理 |
示例:
请求数据
{
"bizId":"f759739a-e6c9-46a2-b0ae-1f61f85da0ac",
"timestamp":1591260938904,
"data":[
{
"code":"仓库",
"value":"value888",
"description":"888 description",
"type":"888"
},
{
"code":"仓库",
"value":"value999",
"description":"999 description",
"type":"999"
},
{
"code":"仓库",
"value":"",
"description":"999 description"
},
{
"code":"仓库2222",
"value":"value999",
"description":"999 description",
"type":"999"
},
{
"code":"仓库",
"value":"仓库",
"description":"999 description",
"type":"999",
"column25":"test"
}
]
}
返回数据
{
"resCode":200000,
"resMsg":"success",
"bizId":"f759739a-e6c9-46a2-b0ae-1f61f85da0ac",
"data":{
"validatorErrors":[
{
"code":"value888,仓库",
"messages":[
"基础主数据名称不能为空",
"基础主数据代码不能为空"
]
},
{
"code":"value999,仓库2222",
"messages":[
"基础主数据类型仓库2222不存在"
]
}
],
"created":"此次请求新建成功了0条数据",
"warnings":[
],
"dbErrors":[
],
"updated":"此次请求更新成功了3条数据"
}
}