文档中心
查看文档
示例代码
接入技术服务
获取比对任务列表
功能描述
用户可以通过此API，获取比对任务列表
请求URL
https://doc-compare.intsig.com/api/contracts/v3/comparison/external/list
HTTP请求方法（Method）
HTTP GET
请求头说明（Request Headers）
请在HTTP请求中添加以下自定义Header。
| header 名 | 值 |
|---|---|
| x-ti-app-id | 请登录textin平台后前往 “工作台-账号设置-开发者信息” 查看 x-ti-app-id |
| x-ti-secret-code | 请登录textin平台后前往 “工作台-账号设置-开发者信息” 查看 x-ti-secret-code |
请求参数说明（Query Parameters）
| 字段名 | 类型 | 描述 |
|---|---|---|
| status | integer | 筛选任务状态： 1 任务完成（待审核） 2 任务解析中 3 任务比对中 4 已审核 -1 任务失败 |
| exception_stages | integer | 筛选任务失败的情况下的失败阶段： 10 解析阶段引起的异常 20 比对阶段引起的异常 |
| page | integer | 分页请求的页码 |
| pagesize | integer | 每页的大小（10-100） |
| start_time | integer | 起始时间，Unix 时间戳格式（单位：秒） |
| end_time | integer | 结束时间，Unix 时间戳格式（单位：秒） |
| search | string | 模糊查询 |
| by_app_id | boolean | 是否只展示该app_id创建的任务（默认：flase, 展示所有的比对任务） |
响应体说明（Response）
Content-Type: application/json
JSON结构说明如下：
| 字段名 | 类型 | 描述 |
|---|---|---|
| code | int | 状态码，非200为错误码，见错误码详情 |
| msg | string | 状态说明 |
| data | object | 比对列表结果 |
| +list | array | 比对列表 |
| ++compare_id | integer | 比对id |
| ++compare_name | array | 比对文档名数组 |
| ++standard_name | string | 标准文档名 |
| ++create_time | integer | 比对任务创建时间 |
| ++diff_summary | object | 差异概要 |
| +++diff_count | integer | 差异数量 |
| +++similarity | float | 相似度 |
| ++doc_id1 | integer | 标准文档id |
| ++doc_id2 | array | 比对文档id数组 |
| ++exception_stage | integer | 失败阶段，详情见请求参数 |
| ++file_type1 | string | 标准文档类型 |
| ++file_type2 | array | 比对文档类型数组 |
| ++max_page1 | integer | 标准文档页码总数 |
| ++max_page2 | array | 比对文档页码总数 |
| ++reasons_for_failure | string | 比对任务失败原因 |
| ++status | integer | 比对任务状态,详情见请求参数 |
| ++task_id | string | 比对任务id |
JSON结构示例
错误码说明
| 错误码 | 描述 |
|---|---|
| 200 | 创建成功 |
| 209 | 任务进行中 |
| 400 | 坏的请求 |
| 401 | 未授权 |
| 403 | 禁止访问 |
| 404 | 未找到资源 |
| 406 | 参数错误 |
| 500 | 服务器内部错误 |
| 40003 | 余额不足，请充值后再使用 |
| 40004 | 参数错误，请查看技术文档，检查传参 |
| 40007 | 机器人不存在或未发布 |
| 40008 | 机器人未开通，请至市场开通后重试 |
| 40101 | x-ti-app-id 或 x-ti-secret-code 为空 |
| 40102 | x-ti-app-id 或 x-ti-secret-code 无效，验证失败 |
| 40103 | 客户端IP不在白名单 |
| 40104 | App has expired 应用已超过有效期 |
| 40105 | Invalid IP source 无效的IP来源 |
| 40106 | App does not match service 应用与service不匹配 |
| 40107 | App has been overdrawn. Please use it after recharging. 应用额度已用完，请充值后使用 |
| 40109 | QPS limit reached, request rejected 达到 qps 限制，请求拒绝 |
| 40202 | Service not support 请求了不支持的服务 |
| 40203 | API is not configured correctly. API配置不正确 |
