Header设置:
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Api-Auth-Actionkey | 是 | C00DnEBzhUK7t4CW4NYjCGQJ | 用户创建表单时的 表单pubkey | |
| Api-Auth-Timestamp | 是 | 1677031824 | 当前时间戳（秒） | |
| Api-Auth-Nonce | 是 | 随机字符串 | ||
| Api-Auth-Sign | 是 | 签名（签名生成规则 ：(Api-Auth-Nonce+Api-Auth-Timestamp+表单secret)的 SHA1 值） | ||
| Laiye-User-Region | 是 | 注册用户地区：CN-中国（大陆、香港、澳门、台湾） DE-其它地区 |
常见错误码:
| code | 描述 |
|---|---|
| 0 | 正常 |
| 10000 | 参数错误 |
| 10001 | 未登录 |
| 10003 | 配置错误 |
| 10004 | 获取授权异常 |
| 10005 | 产品授权已过期，请联系管理员 |
| 10006 | json序列化错误 |
| 10007 | 数据处理失败 |
| 10102 | 协同表单不存在 |
| 10200 | 协同任务创建失败 |
| 10202 | 协同任务不存在 |
| 10300 | 数据库错误 |
| 10501 | 获取用户信息失败 |
| 10703 | 读取文件失败 |
| 10705 | 文件为空，请检查后重试 |
| 10709 | 上传文件失败 |
Path： /cloud.laiye.com/api/rpa_collaboration/v2/task/create
Method： POST
接口描述：
传入文件（不超过20M，支持jpeg， jpg， png， pdf， bmp， tiff格式），将基于人机表单中关联的 IDP模型进行抽取，经配置条件的筛选后生成协同任务
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| source | string | 必须 | 来源（固定写：openapi） | ||
| attachment | string | 必须 | 文件base64数据 | ||
| file_name | string | 必须 | 文件名称（eg:sss.jpg） | ||
| need_update | boolean | 非必须 | 是否创建需要更新的任务。（希望在创建任务的基础上，更新 IDP模型抽取值）默认为 false。可选值包括: - true：等待用户调用 [更新协同任务] 接口传入更新内容 - false：不等待调用 | ||
| fields_value_options | object [] | 非必须 | 传入字段值备选范围数据，数量上限为 100个。（在创建的协同任务上，为特定字段增加字段值的备选范围，将在任务处理页面上展示为下拉选值框。） | item 类型: object | |
| ├─ field_name | string | 必须 | 字段名称 | ||
| ├─ options | string [] | 必须 | 备选值范围(数组) | item 类型: string | |
| ├─ | 非必须 |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | integer | 必须 | |||
| data | string | 必须 | |||
| message | string | 必须 |
Path： /cloud.laiye.com/api/rpa_collaboration/v2/task/update
Method： POST
接口描述：
为 task_status 为 “8-待更新” 状态的协同任务，传入更新内容（该字段名、更新后的字段值等），基于 IDP模型抽取结果进行更新。
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| task_sn | string | 必须 | 协同任务编号 | ||
| update_fields_data | object [] | 非必须 | 传入协同任务更新内容 | item 类型: object | |
| ├─ field_name | string | 必须 | 需更新的字段名称 | ||
| ├─ field_value | object | 必须 | 更新后的字段值，传 text/text_list 二选一。（将仅替换抽取结果的 value 值，而保留在文档中的回标位置信息） | ||
| ├─ text | string | 非必须 | 需更新的字段为“字符串”类型时，通过此参数传字段值 | ||
| ├─ text_list | string [] | 非必须 | 需更新的字段为“数组”类型时，通过此参数传字段值 | item 类型: string | |
| ├─ | 非必须 | ||||
| fields_value_options | object [] | 非必须 | 传入字段值备选范围数据，数量上限为 100个。（在创建的协同任务上，为特定字段增加字段值的备选范围，将在任务处理页面上展示为下拉选值框。） | item 类型: object | |
| ├─ field_name | string | 必须 | 字段名称 | ||
| ├─ options | string [] | 必须 | 备选值范围(数组) | item 类型: string | |
| ├─ | 非必须 |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | integer | 必须 | |||
| message | string | 必须 | |||
| data | string | 必须 | success/failure |
Path： /cloud.laiye.com/api/rpa_collaboration/v2/task/result
Method： GET
接口描述：
查询协同任务的处理状态和数据详情
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| task_sn | task_sn |
Query
| 参数名称 | 是否必须 | 示例 | 备注 |
|---|---|---|---|
| task_sn | 是 | 协同任务编号 |
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | integer | 必须 | |||
| data | object | 必须 | |||
| ├─ action_id | integer | 必须 | |||
| ├─ task_data | string | 非必须 | "任务的数据详情。 - task_status=3 时，返回任务的最终结果（对应人机页面上【已完成】的任务状态）； - task_status=8 时，返回 IDP模型抽取结果（调用[更新协同任务]API前，由IDP返回的结果）； - task_status为其它值时，不返回本参数。" | ||
| ├─ task_err_msg | string | 非必须 | 任务错误信息（如果任务成功则此字段为空） | ||
| ├─ task_sn | string | 必须 | 协同任务编号 | ||
| ├─ task_status | integer | 必须 | （1-待接收 2-待处理 3-任务处理完成 4-取消任务 5-任务超时 6-创建任务失败 7-等待中 8-待更新） | ||
| ├─ need_update | boolean | 非必须 | 是否为需要更新的任务 | ||
| ├─ fields_value_options | object [] | 非必须 | 传入的字段值备选范围数据 | item 类型: object | |
| ├─ field_name | string | 必须 | 字段名称 | ||
| ├─ options | string [] | 必须 | 备选值范围（数组） | item 类型: string | |
| ├─ | 非必须 | ||||
| message | string | 必须 |