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/listModelFieldInfoByClassificationIdNoList
DocFlow-平台化接口 审核部分
模型字段列表,请求参数需从前置接口获取。
前置接口:/api/app-api/sip/platform/v2/review/listExecuteTasksByFileBatchNo
作用:用于创建规则时的前置接口,获取批次下的所有分类id,可以从返回结果中选择需要用于创建规则的分类
关键返回结果字段:taskClassificationIdNo(分类id)
前置接口:/api/app-api/sip/platform/v2/review/getRulesByClassificationIdNo
作用:用于修改规则时的前置接口,获取规则的分类id信息
关键返回结果字段:classificationIdNoList(当前规则配置的分类id列表)
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://docflow.textin.com/api/app-api/sip/platform/v2/review/listModelFieldInfoByClassificationIdNoList' \
--header 'x-ti-app-id;' \
--header 'x-ti-secret-code;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "classificationIdNoList": [
        1,
        2,
        3
    ]
}'
响应示例响应示例
{
    "code": 200,
    "data": [
        {
            "id": 29026,
            "fieldName": "赵六",
            "description": "赵六",
            "fieldPrompt": "赵六",
            "modelIdNo": "1024",
            "fieldCode": "1024",
            "sysFieldId": "1024",
            "fieldType": "1024",
            "fieldFormat": "1024",
            "blockType": 1024,
            "tableIdNo": 1024,
            "tableId": 1024,
            "tableName": "Table Name",
            "requiredStatus": 1024,
            "sort": 1,
            "textInLines": [
                {
                    "angle": 0,
                    "pos": [
                        1
                    ],
                    "page": 1,
                    "text": "文本内容",
                    "char_pos": [
                        [
                            1
                        ]
                    ]
                }
            ],
            "enableStatus": 1,
            "enableFlag": "Y",
            "classificationIdNo": 123
        }
    ],
    "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列表
必需
示例值:
[1,2,3]
示例

返回响应

🟢200成功
*/*
OK
Body
code
integer 
状态码
可选
示例值:
200
data
array[object (ApiModelFieldRespVO) {19}] 
可选
id
integer 
必需
主键ID,此字段含义同fieldId
示例值:
29026
fieldName
string 
字段名称
必需
示例值:
赵六
description
string 
字段描述
必需
示例值:
赵六
fieldPrompt
string 
字段提示
可选
示例值:
赵六
modelIdNo
string 
所属模型IdNo
可选
示例值:
1024
fieldCode
string 
字段code
可选
示例值:
1024
sysFieldId
string 
关联系统字段ID
可选
示例值:
1024
fieldType
string 
字段类型
可选
示例值:
1024
fieldFormat
string 
字段格式化格式
可选
示例值:
1024
blockType
integer 
可选
字段模块 0:基本字段 1:表格字段
示例值:
1024
tableIdNo
integer 
表格ID
可选
示例值:
1024
tableId
integer 
可选
表格ID,含义同tableIdNo
示例值:
1024
tableName
string 
表格名称
可选
示例值:
Table Name
requiredStatus
integer 
可选
是否必填状态 0:选填字段 1:必填字段
示例值:
1024
sort
integer 
排序
可选
示例值:
1
textInLines
array[object (TextInLines) {5}] 
字段坐标
可选
enableStatus
integer 
可选
是否启用 0:禁用 1;启用 2: 草稿
示例值:
1
enableFlag
string 
可选
是否开启, Y:是, N:否
示例值:
Y
classificationIdNo
integer 
分类ID
可选
示例值:
123
msg
string 
状态信息
可选
示例值:
成功
traceId
string 
链路id
可选
示例值:
1234abcd
上一页
文件任务列表
下一页
创建审核规则
Built with