选项列表查询接口
业务场景
该接口用于根据选项编码或名称分页查询某自定义档案下的选项信息。
若需要获取自定义档案编码,可以通过系统查看或者调用自定义档案列表查询接口。
若需查看选项详情(如限定条件、过滤条件),请调用选项详情查询接口。
接口限制
10次/秒/企业
接口地址
/api/openapi/reference/v2/data/detail/query
请求类型
POST
请求参数
请求参数说明:
字段名称 |
字段类型 |
是否必填 |
字段说明 |
referenceDataBizCode |
string |
是 |
自定义档案编码 |
keyword |
string |
否 |
根据选项名称或选项编码模糊查询 |
pageNo |
int |
否 |
当前分页页数,第一页从1开始,默认为1 |
pageSize |
int |
否 |
分页条数,默认值50,最大值是100 |
updatedStartAt |
long |
否 |
最近修改时间,时间戳。查询在此时间及之后修改的数据 |
updatedEndAt |
long |
否 |
最近修改时间,时间戳。查询在此时间及之前修改的数据。不能小于updatedStartAt |
请求参数示例
{
"referenceDataBizCode":"RD15451",
"keyword":"15451",
"pageNo":1,
"pageSize":50,
"updatedStartAt":1590479571000,
"updatedEndAt":1590479572000
}
响应参数
正常响应参数示例
{
"code": "ACK",
"message": "",
"data": {
"list": [
{
"bizCode": "RDD2011041131924G",
"name": "康师傅",
"nameDisplay": "{\"zh\": \"康师傅\", \"en\": \"kangshifu\"}",
"enabled":true,
"parentCode":"RD2005261HVT079D",
"parentNameZh":"一级",
"parentNameEn":"level 1",
"parentName":"一级"
},{
"bizCode": "A0533051",
"name": "康1",
"nameDisplay": "{\"zh\": \"\", \"en\": \"康1\"}",
"enabled": true,
"parentCode": "RD2005261HVT079D",
"parentNameZh":"一级",
"parentNameEn":"level 1",
"parentName":"一级"
}
],
"hasNextPage": false
},
"success": true
}
响应参数说明
字段 |
字段类型 |
字段说明 |
code |
String |
返回结果 |
message |
String |
返回提示 |
data |
Json |
返回结果 |
success |
boolean |
是否成功 |
data下list数据
字段名称 |
字段类型 |
字段说明 |
bizCode |
string |
档案编码 |
name |
string |
档案名称 |
nameDisplay |
string |
包含了所有语言的名称文案。zh(中文)不管是否为空均会返回,其他语言的文案不为空才会返回。字段名称按照标准语言的缩写,比如zh代表中文(默认简体),en代表英文,ja代表日文,zh_CN代表简体中文,zn_TW 代表繁体中文。 |
enabled |
string |
是否启用 |
parentCode |
string |
上级分类编码/顶级档案编码 |
parentNameZh |
string |
上级分类名称/顶级档案名称(中文) |
parentNameEn |
string |
上级分类名称/顶级档案名称(英文) |
parentName |
string |
上级分类名称/顶级档案名称 |
parentCode |
string |
上级分类编码/顶级档案分类编码 |
修改记录
新建 根据选项编码或者名称模糊查询选项信息(带分页)文档 v2