批量导入选项(自定义档案)信息
业务场景
该接口用于批量更新或保存选项信息。
接口说明
- 单次导入不能超过50条
- 该接口支持部分成功，即一条失败，不影响其他成功的数据
- 若有传分类参数，则必须保证该分类路径或编码已存在，或先调用选项分类导入接口导入分类。
接口限制
10次/秒/企业
接口地址
/api/openapi/reference/data/detail
请求类型
POST
请求参数
请求参数说明
| 字段名称 | 字段类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| referenceDataDetails | List<referenceDataDetail> | 是 | 选项信息 |
| bizCode | string | 是 | 自定义档案根目录code（全局唯一） |
referenceDataDetails参数说明：
| 字段名称 | 字段类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| name（中文） | String(100) | 选填（名称三个字段必填一个） | 选项名称(若设置为“名称不可重复”，则该自定义档案下全局唯一；否则不限制唯一性) |
| nameEn（英文） | string(100) | 选填（名称三个字段必填一个） | 选项英文名称(若设置为“名称不可重复”，则该自定义档案下全局唯一；否则不限制唯一性) |
| nameZh（中文） | string(100) | 选填（名称三个字段必填一个） | 选项中文名称(若设置为“名称不可重复”，则该自定义档案下全局唯一；否则不限制唯一性) |
| bizCode | string | 是 | 自定义档案下的选项code（全局唯一) |
| fullCategoryName | string | 选填（不填则表示选项直接挂在档案根目录下） | 分类的全路径名称，以,间隔，第一个是最上层的分类名称（除自定义档案外），如"分类一,分类二"。 建议使用categoryBizCode |
| categoryBizCode | string | 选填（不填则表示选项直接挂在档案根目录下） | 末级分类的编码BizCode，在同时填写fullCategoryName的情况下，以categoryBizCode为准。 |
| principals | List<String> | 选填，不填时视为维持原数据，填写空数组时视为清除原数据 | 选项负责人（填员工工号） |
| enabled | boolean | 是 | 是否启用 |
| referenceDataAuthz | List<referenceDataAuthz> | 选填，不填时视为维持原数据，填写空数组时视为清除原数据 | 选项可见性 |
| rolePrincipals | array | 选填，和principals互斥，都填则只会取该字段 | 选项角色人员（灰度功能，暂时只对部分企业开放） |
referenceDataAuthz参数说明：
| 字段名称 | 字段类型 | 是否必填 | 字段说明 |
|---|---|---|---|
| bizCode | String | 是 | 业务编码 |
| type | string | 选填（名称三个字段必填一个） | 可见性类型，可选值如下: STAFF（人员） DEPARTMENT（部门） LEGAL_ENTITY（公司抬头） USER_GROUP（用户组） FORM_SUB_TYPE（单据类型编码） |
| includeChild | bool | 是 | 是否包含子部门（只有当type为DEPARTMENT才会生效） |
请求参数示例
{
"bizCode": "SYX54321",
"referenceDataDetails": [
{
"name": "测试用选项",
"nameEn": "英文名称",
"nameZh": "中文名称",
"bizCode": "SYXD123456",
"fullCategoryName": "分类a,分类a-1",
"principals": [
"SYX003",
"MW001"
],
"enabled": true,
"referenceDataAuthz": [
{
"bizCode": "部门编码1",
"type": "DEPARTMENT",
"includeChild": false
},
{
"bizCode": "员工工号1",
"type": "STAFF"
},
{
"bizCode": "公司抬头编码1",
"type": "LEGAL_ENTITY"
},
{
"bizCode": "用户组1",
"type": "USER_GROUP"
}
],
"rolePrincipals": [
{
"bizCode": "ROLE",
"principals": [
"SYX003",
"MW001"
]
}
]
},
{
"name": "测试用选项1",
"nameEn": "英文名称",
"bizCode": "SYXD1234567",
"fullCategoryName": "分类b",
"principals": [
"SYX003",
"MW001"
],
"extraProperty": {
"key1": "value1"
},
"enabled": true,
"categoryBizCode": "CODE001"
}
]
}
响应参数：
响应参数说明：
| 字段 | 字段类型 | 字段说明 |
|---|---|---|
| code | String | 返回结果 |
| message | String | 返回提示 |
| data | Json | 返回结果 |
| success | boolean | 是否成功 |
data.errorData数据参数说明
| 字段 | 字段类型 | 字段说明 |
|---|---|---|
| key | String | 主键，对应错误参数的bizcode |
| errorMessage | String | 返回的错误提示 |
| errorIndex | Json | 错误信息的数据下标 |
正常响应参数示例
{
"code": "ACK",
"message": "",
"data": null,
"errorCode": null,
"success": true
}
异常响应参数示例
自定义档案根目录bizcode参数错误
{
"code": "NACK",
"message": "未找到选项组",
"data": null,
"errorCode": null,
"success": false
}
referenceDataDetails内参数异常
{
"code": "NACK",
"message": "",
"data": {
"errorData": [
{
"key": "TEST",
"errorCode": "200016",
"errorMessage": "选项分类业务编码不存在",
"errorIndex": 1
}
]
},
"errorCode": null,
"success": false
}
修改记录
2021-01-13 增加rolePrincipals字段，灰度功能，目前只对部分试点客户开放
2021-02-22 增加nameZh和nameEn字段，原本的name和现在的nameZh代表选项中文名称，name的优先级高于nameZh，当name不为空时会将name当做中文选项名称
2021-04-10 当导入的选项组下是允许选项和分类名称重复时，该接口只认categoryBizCode，如果categoryBizCode为空默认导入到根分类下
2021-09-23 extraProperties目前没有使用，暂时停用