待归档列表查询
- 接口:common/archive/list
- Method:POST
- 数据格式:JSON
- 限流信息:100次每天和50次每小时
- 多语言环境:在接口请求头中添加Key为locale,Value值为语言环境,目前支持的语言有zh_CN(中文)、en_US(英文)、ja_JP(日文)、zh_TW(繁体),请选取其中一种
- 接口说明:电子档案待归档列表查询接口,默认返回第一页内容
- 其他补充信息:
参数:
请求参数
字段名称 |
字段类型 |
字段描述 |
是否必填 |
长度限制(字节) |
bizId |
String |
当前次接口同步的唯一标识(UUID) |
TRUE |
36 |
timestamp |
long |
当前次接口同步时间对应的时间戳(TIMESTAMP) |
TRUE |
13 |
data |
JSONObject |
请求数据体 |
TRUE |
无 |
data.start_datetime |
long |
请求开始时间戳,如第三方电子档案系统定时任务开始时间,可以同timestamp一致,确保表单最新修改时间小于该时间戳 |
TRUE |
13 |
返回参数
字段名称 |
字段类型 |
字段描述 |
resCode |
Integer |
状态码(200000/500000) |
resMsg |
String |
返回信息描述(更新成功/更新失败) |
bizId |
String |
当前次接口同步的唯一标识 |
data |
JSONArray |
返回数据体 |
data[].code |
String |
电子档案唯一编码 |
data[].archive_status |
String |
业务归档状态(pending-待归档、error-归档失败) |
data[].archive_message |
String |
业务归档信息,用于记录归档失败的原因 |
示例:
请求数据
{
"bizId": "dbe1c496-0d51-415e-87a5-ed104dea597f",
"timestamp": 1636600092809,
"data": {
"start_datetime": 1636600092809
}
}
返回数据
{
"resCode": 200000,
"resMsg": "SUCCESS",
"bizId": "dbe1c496-0d51-415e-87a5-ed104dea597f",
"data": [
{
"code": "EXP0000000260",
"archive_status": "pending"
},
{
"code": "REQ0000000420",
"archive_status": "archiving"
},
{
"code": "REQ0000000621",
"archive_status": "error",
"archive_message": "归档失败"
}
]
}