Skip to main content
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
review
/
update
Update Review Rule
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/review/update \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '{
  "ruleIdNo": 12345,
  "ruleName": "Rule name",
  "rulePrompt": "Rule prompt",
  "fields": [
    {
      "classificationIdNo": 1234,
      "classificationName": "ID Card",
      "basicFields": [
        {
          "fieldId": 1234,
          "fieldName": "Card Number"
        }
      ],
      "tableFields": [
        {
          "tableId": -1,
          "tableName": "Table1",
          "fields": [
            {
              "fieldId": 1234,
              "fieldName": "Card Number"
            }
          ]
        }
      ]
    }
  ]
}'
{
  "code": 200,
  "data": {
    "version": 1
  },
  "msg": "Success",
  "traceId": "12345ABC"
}

Authorizations

​
x-ti-app-id
string
header
required
​
x-ti-secret-code
string
header
required

Headers

​
x-ti-app-id
string
required

x-ti-app-id

Example:

"1234abcd"

​
x-ti-secret-code
string
required

x-ti-secret-code

Example:

"1234abcd"

Body

application/json

Update rule request input parameters

​
ruleIdNo
string
required

Review rule unique ID, same meaning as reviewRuleIdNo

Example:

12345

​
ruleName
string
required

Review rule name

Maximum length: 255
Example:

"Rule name"

​
rulePrompt
string
required

Review rule prompt

Maximum length: 1000
Example:

"Rule prompt"

​
fields
object[]

Associated field information

Response

200 - */*

OK

​
code
integer

Status code

Example:

200

​
data
object

Update rule response result VO

​
msg
string

Status message

Example:

"Success"

​
traceId
string

Trace ID

Example:

"12345ABC"