跳转到主要内容
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
fields
/
batch_add
新增文件类别字段
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/batch_add \
  --header 'Content-Type: application/json' \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>' \
  --data '
{
  "workspace_id": "1234567890",
  "category_id": "1234567890",
  "fields": [
    {
      "name": "发票代码",
      "description": "发票代码描述",
      "prompt": "<string>",
      "use_prompt": true,
      "alias": [
        "发票号",
        "票号",
        "Invoice No."
      ],
      "identity": "invoice_number",
      "multi_value": true,
      "duplicate_value_distinct": true,
      "transform_settings": {
        "datetime_settings": {
          "format": "yyyy-MM-dd"
        },
        "enumerate_settings": {
          "items": [
            "增值税专用发票",
            "增值税普通发票",
            "电子发票"
          ]
        },
        "regex_settings": {
          "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
          "replace": "$1/$2/$3"
        },
        "mismatch_action": {
          "default_value": "N/A"
        }
      }
    }
  ],
  "table_id": "<string>",
  "with_detail": true
}
'
{
  "code": 200,
  "msg": "<string>",
  "result": [
    {
      "field_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "prompt": "<string>",
      "use_prompt": true,
      "alias": [
        "<string>"
      ],
      "identity": "<string>",
      "multi_value": true,
      "duplicate_value_distinct": true,
      "transform_settings": {
        "datetime_settings": {
          "format": "yyyy-MM-dd"
        },
        "enumerate_settings": {
          "items": [
            "增值税专用发票",
            "增值税普通发票",
            "电子发票"
          ]
        },
        "regex_settings": {
          "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
          "replace": "$1/$2/$3"
        },
        "mismatch_action": {
          "default_value": "N/A"
        }
      },
      "extract_model": "<string>",
      "enabled": 123
    }
  ]
}

授权

x-ti-app-id
string
header
必填
x-ti-secret-code
string
header
必填

请求体

application/json
workspace_id
string
必填

空间ID

示例:

"1234567890"

category_id
string
必填

文件类别ID

示例:

"1234567890"

fields
object[]
必填

批量新增的字段列表

Minimum array length: 1
table_id
string

表格ID

  • 不传或为空:创建普通字段
  • 传入表格ID:创建对应表格下的表格字段
with_detail
boolean

是否返回每个字段的完整详情

响应

200 - application/json

批量新增字段成功

code
integer
必填

状态码

示例:

200

msg
string
必填

状态描述

result
object[]

创建结果列表,顺序与请求一致