Textin DocFlow API文档
  1. 智能审核
Textin DocFlow API文档
  • REST API 开发者文档概述
  • DocFlow业务处理流程
  • 接口认证
  • 状态码列表
  • 应用场景
    • 文档解析
    • 文档分类
    • 信息抽取
    • 智能审核
  • REST API 列表
    • 智能审核
      • 审核接口使用教程说明
      • 审核接口字段依赖
      • 文件批次列表
        GET
      • 文件任务类别列表
        GET
      • 审核规则列表
        POST
      • 文件任务列表
        POST
      • 模型字段列表
        POST
      • 创建审核规则
        POST
      • 更新审核规则
        POST
      • 删除审核规则
        POST
      • 试运行审核规则
        POST
      • 提交审核任务
        POST
      • 审核规则任务列表
        POST
    • 上传文件
      POST
    • 获取文件处理结果列表
      GET
    • 更新文件处理结果
      POST
  1. 智能审核

审核规则列表

POST
/api/app-api/sip/platform/v2/review/getRulesByClassificationIdNo
DocFlow-平台化接口 审核部分
审核规则列表(一般不传分类获取批次下所有规则),部分请求参数需从前置接口获取。
前置接口:/api/app-api/sip/platform/v2/review/listByFileBatchNo
作用:根据workspaceIdNo获取批次列表信息,workspaceIdNo从页面获取
关键返回结果字段:fileBatchNo
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://docflow.textin.com/api/app-api/sip/platform/v2/review/getRulesByClassificationIdNo' \
--header 'x-ti-app-id;' \
--header 'x-ti-secret-code;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "classificationIdNoList": [
        123
    ],
    "workspaceIdNo": 123,
    "fileBatchNo": "abcd"
}'
响应示例响应示例
{
    "code": 200,
    "data": [
        {
            "id": 1,
            "reviewRuleIdNo": 1,
            "reviewRuleType": "single",
            "reviewRulePrompt": "审核规则提示内容",
            "fileBatchNo": "abcd",
            "reviewRuleName": "abcd",
            "workspaceIdNo": 1234,
            "classificationIdNoList": [
                1234
            ],
            "version": 1,
            "fieldInfoList": [
                {
                    "fieldId": 1234,
                    "fieldName": "名称",
                    "blockType": 0,
                    "tableId": -1,
                    "tableName": "Table1",
                    "classificationIdNo": 123,
                    "classificationName": "身份证"
                }
            ]
        }
    ],
    "msg": "成功",
    "traceId": "1234abcd"
}

请求参数

Header 参数
x-ti-app-id
string 
必需
x-ti-app-id
示例值:
1234abcd
x-ti-secret-code
string 
必需
x-ti-secret-code
示例值:
1234abcd
Body 参数application/json
根据分类ID返回任务队列信息列表-请求VO
classificationIdNoList
array[string]
分类ID列表
可选
workspaceIdNo
string 
工作空间ID
必需
示例值:
123
fileBatchNo
string 
文件批次号
必需
示例值:
abcd
示例

返回响应

🟢200成功
*/*
OK
Body
code
integer 
状态码
可选
示例值:
200
data
array[object (ApiReviewRuleVO) {10}] 
可选
id
integer 
主键ID
可选
示例值:
1
reviewRuleIdNo
integer 
审核规则唯一id
可选
示例值:
1
reviewRuleType
string 
可选
审核规则类型 (single | multiple)
示例值:
single
reviewRulePrompt
string 
审核规则提示
可选
示例值:
审核规则提示内容
fileBatchNo
string 
文件批次号
可选
示例值:
abcd
reviewRuleName
string 
审核规则名称
可选
示例值:
abcd
workspaceIdNo
integer 
工作空间唯一编号
可选
示例值:
1234
classificationIdNoList
array[integer]
分类ID列表
可选
version
integer 
审核规则版本
可选
示例值:
1
fieldInfoList
array[object (ReviewRuleFieldDTO) {7}] 
字段信息平铺列表
可选
msg
string 
状态信息
可选
示例值:
成功
traceId
string 
链路id
可选
示例值:
1234abcd
上一页
文件任务类别列表
下一页
文件任务列表
Built with