更新审核规则

POST

/api/app-api/sip/platform/v2/review/update

更新审核规则，调用接口前需要调用一些前置接口。

前置接口：/api/app-api/sip/platform/v2/review/listModelFieldInfoByClassificationIdNoList
作用：获取分类下的字段信息
关键返回结果字段：id（含义同fieldId）、fieldName、blockType（区分是普通字段还是表格字段）、classificationIdNo（区分字段属于哪个分类）、 tableIdNo（表格id，如果字段是表格字段）、tableName（表格名称，如果字段是表格字段）

前置接口：/api/app-api/sip/platform/v2/review/getRulesByClassificationIdNo
作用：根据workspaceIdNo和fileBatchNo获取当前批次的所有审核规则
关键返回结果字段：classificationIdNoList（当前规则配置的分类id列表）、fieldInfoList（当前规则配置的字段信息列表）、reviewRuleIdNo（审核规则id）

请求参数

Authorization

API Key

在 header 添加参数

x-ti-app-id

示例：

x-ti-app-id: ********************

API Key

在 header 添加参数

x-ti-secret-code

示例：

x-ti-secret-code: ********************

Header 参数

Body 参数application/json必填

示例

{
    "ruleIdNo": 12345,
    "ruleName": "规则名称",
    "rulePrompt": "规则提示",
    "fields": [
        {
            "classificationIdNo": 1234,
            "classificationName": "身份证",
            "basicFields": [
                {
                    "fieldId": 1234,
                    "fieldName": "卡号"
                }
            ],
            "tableFields": [
                {
                    "tableId": -1,
                    "tableName": "Table1",
                    "fields": [
                        {
                            "fieldId": 1234,
                            "fieldName": "卡号"
                        }
                    ]
                }
            ]
        }
    ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://docflow.textin.com/api/app-api/sip/platform/v2/review/update' \
--header 'x-ti-app-id: <api-key>' \
--header 'x-ti-secret-code: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ruleIdNo": 12345,
    "ruleName": "规则名称",
    "rulePrompt": "规则提示",
    "fields": [
        {
            "classificationIdNo": 1234,
            "classificationName": "身份证",
            "basicFields": [
                {
                    "fieldId": 1234,
                    "fieldName": "卡号"
                }
            ],
            "tableFields": [
                {
                    "tableId": -1,
                    "tableName": "Table1",
                    "fields": [
                        {
                            "fieldId": 1234,
                            "fieldName": "卡号"
                        }
                    ]
                }
            ]
        }
    ]
}'

返回响应

🟢200成功

*/*

Body

示例

{
    "code": 200,
    "data": {
        "version": 1
    },
    "msg": "成功",
    "traceId": "12345ABC"
}

修改于 2025-09-01 09:58:12

创建审核规则

删除审核规则