メインコンテンツへスキップ
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
fields
/
batch_update
ファイルカテゴリのフィールドを更新
curl --request POST \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/batch_update \
  --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": [
    {
      "field_id": "1234567890",
      "name": "<string>",
      "description": "<string>",
      "prompt": "<string>",
      "use_prompt": true,
      "alias": [
        "インボイス No.",
        "請求書番号"
      ],
      "identity": "invoice_number",
      "multi_value": true,
      "duplicate_value_distinct": true,
      "transform_settings": {
        "datetime_settings": {
          "format": "yyyy-MM-dd"
        },
        "enumerate_settings": {
          "items": [
            "VAT 専用インボイス",
            "VAT 一般インボイス",
            "電子インボイス"
          ]
        },
        "regex_settings": {
          "match": "^(\\d{4})-(\\d{2})-(\\d{2})$",
          "replace": "$1/$2/$3"
        },
        "mismatch_action": {
          "default_value": "N/A"
        }
      },
      "extract_model": "Model 1"
    }
  ],
  "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": [
            "VAT 専用インボイス",
            "VAT 一般インボイス",
            "電子インボイス"
          ]
        },
        "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
with_detail
boolean

更新後の各フィールドの完全な詳細を返すかどうか

レスポンス

200 - application/json

フィールドの更新に成功

code
integer
必須

ステータスコード

:

200

msg
string
必須

ステータス説明

result
object[]

with_detail=true の場合は更新後のフィールドリスト、それ以外は null