1. 文件解析接口
文件解析。
请求方式:POST
请求地址:/bosdocumentservice/{appkey}/documents/parse/{documentKey}
1.1. 请求参数:
Headers:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
Authorization | string | c4570cb9ca324bc8ba7dd9d1967710ea | 是 | access_token |
PathParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
documentKey | string | NULL | 是 | 文档key |
SearchParas:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
transactionCode | string | 3MD2XzN70VkcvbXllg7x7V | 否 | 业务事务编码 |
Body:
multipart/form-data:
NULL
1.2. 参数说明:
参数名 | 类型 | 示例 | 是否必填 | 参数含义 |
---|---|---|---|---|
NULL | NULL | NULL | NULL | NULL |
1.3. 正确返回:
Http Status Code:200
{
"code":"SUCCESS",
"message":"请求处理成功",
"data":true
}
1.4. 状态码:
状态码 | code | message | data | 原因 |
---|---|---|---|---|
200 | ENTITY_NOTFOUND | Key为{key}的{bosclass}实体对象不存在 | NULL | 当documentKey的文档不存在时 |
200 | ENTITY_WRITEPERMISSION_REQUIRED | 缺少实体对象{bosclass/key}的写权限 | NULL | 当documentKey对应的文档文件无写权限 |
200 | BOSCLASS_NA | 不适用于{bosclass}类型实例数据 | NULL | 当documentKey的文档对应bosclass不为documents时 |
1.5. 注意事项:
1、查询documentKey对应文档是否存在。
2、查询documentKey关联的文件file。
3、根据file记录值,发起模型解析请求。
4、请求成功后更新file和document。