- REST API 开发者文档概述
- 状态码列表
- 接口认证
- DocFlow 业务处理流程
- REST API 列表
- 数据模型
- Schemas
- RecognitionStatus
- VerificationStatus
- CodeMessage
- KeyValue
- WorkspaceId
- StampValue
- WorkspaceItem
- HandWritingValue
- CategoryId
- Document
- CategoryField
- SubFileDetailInfo
- CommonFieldDetailRespVO
- TaskCropResult
- CategoryListItem
- CategoryItem
- CategorySampleId
- CategorySampleListItem
- ApiRuleReviewUpdateReqVO
- CommonResultApiRuleReviewUpdateRespVO
- Field
- BasicField
- TableField
- ApiRuleReviewUpdateRespVO
- ApiReviewTaskSubmitReqVO
- CommonResultListApiReviewTaskSubmitRespVO
- ApiReviewTaskSubmitRespVO
- ApiReviewRuleRunReqVO
- CommonResultApiReviewRuleTaskVO
- ApiReviewRuleTaskVO
- DocumentOcrPosition
- ApiClassificationQueryReqVO
- CommonResultListApiReviewRuleBindingTaskDetailRespVO
- ApiReviewRuleBindingTaskDetailRespVO
- ApiReviewRuleAndTaskReqVO
- CommonResultListApiReviewRuleAndTaskRespVO
- ApiReviewRuleAndTaskRespVO
- ReviewRuleDTO
- ReviewRuleFieldDTO
- ReviewRuleTaskDO
- ApiClassificationIdNoListReqVO
- CommonResultListApiModelFieldRespVO
- ApiModelFieldRespVO
- TextInLines
- CommonResultListApiReviewRuleVO
- ApiReviewRuleVO
- ApiRuleReviewDeleteReqVO
- CommonResultBoolean
- ApiRuleReviewCreateReqVO
- CommonResultApiRuleReviewCreateRespVO
- ApiRuleReviewCreateRespVO
- CommonResultListApiFileBatchExecuteTaskRespVO
- ApiFileBatchExecuteTaskRespVO
- CommonResultListApiFileBatchInfoRespVO
- ApiFileBatchInfoRespVO
- ClassificationVO
- Schemas
创建审核规则
POST
/api/app-api/sip/platform/v2/review/create
前置接口：/api/app-api/sip/platform/v2/review/listExecuteTasksByFileBatchNo
作用：获取批次下的所有分类id
关键返回结果字段：taskClassificationIdNo（分类id）
前置接口：/api/app-api/sip/platform/v2/review/listModelFieldInfoByClassificationIdNoList
作用：获取分类下的字段信息
关键返回结果字段：id（含义同fieldId）、fieldName、blockType（区分是普通字段还是表格字段）、classificationIdNo（区分字段属于哪个分类）、 tableIdNo（表格id，如果字段是表格字段）、tableName（表格名称，如果字段是表格字段）
请求参数
Authorization
API Key
在 header 添加参数
x-ti-app-id
示例：
x-ti-app-id: ********************API Key
在 header 添加参数
x-ti-secret-code
示例：
x-ti-secret-code: ********************or
Header 参数
Body 参数application/json必填
示例
{
"ruleName": "审核规则123",
"rulePrompt": "审核规则提示内容",
"classificationIdNoList": [
123
],
"fileBatchNo": "abcd",
"workspaceIdNo": 123,
"fields": [
{
"classificationIdNo": 1234,
"classificationName": "身份证",
"basicFields": [
{
"fieldId": 1234,
"fieldName": "卡号"
}
],
"tableFields": [
{
"tableId": -1,
"tableName": "Table1",
"fields": [
{
"fieldId": 1234,
"fieldName": "卡号"
}
]
}
]
}
]
}请求示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://docflow.textin.com/api/app-api/sip/platform/v2/review/create' \
--header 'x-ti-app-id: <api-key>' \
--header 'x-ti-secret-code: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"ruleName": "审核规则123",
"rulePrompt": "审核规则提示内容",
"classificationIdNoList": [
123
],
"fileBatchNo": "abcd",
"workspaceIdNo": 123,
"fields": [
{
"classificationIdNo": 1234,
"classificationName": "身份证",
"basicFields": [
{
"fieldId": 1234,
"fieldName": "卡号"
}
],
"tableFields": [
{
"tableId": -1,
"tableName": "Table1",
"fields": [
{
"fieldId": 1234,
"fieldName": "卡号"
}
]
}
]
}
]
}'返回响应
🟢200成功
*/*
Body
示例
{
"code": 200,
"data": {
"ruleIdNo": 1234
},
"msg": "成功",
"traceId": "1234abcd"
}修改于 2025-09-01 09:58:12