メインコンテンツへスキップ
GET
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
fields
/
list
ファイルカテゴリのフィールド一覧を取得
curl --request GET \
  --url https://docflow.textin.com/api/app-api/sip/platform/v2/category/fields/list \
  --header 'x-ti-app-id: <api-key>' \
  --header 'x-ti-secret-code: <api-key>'
{
  "code": 200,
  "msg": "<string>",
  "result": {
    "fields": [
      {
        "name": "インボイスコード",
        "description": "インボイスコードの説明",
        "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"
          }
        },
        "id": "1234567890",
        "extract_model": "Model 1"
      }
    ],
    "tables": [
      {
        "id": "1234567890",
        "name": "Table 1",
        "description": "テーブルの説明",
        "prompt": "各行から品目名、数量、金額を抽出します",
        "collect_from_multi_table": true,
        "extract_model": "Model 1",
        "fields": [
          {
            "name": "インボイスコード",
            "description": "インボイスコードの説明",
            "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"
              }
            },
            "id": "1234567890",
            "extract_model": "Model 1"
          }
        ]
      }
    ]
  }
}

承認

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

クエリパラメータ

workspace_id
string
必須

ワークスペース ID

:

"1234567890"

category_id
string
必須

ファイルカテゴリ ID

:

"1234567890"

レスポンス

200 - application/json

ファイルカテゴリフィールド一覧の取得に成功

code
integer
必須

ステータスコード

:

200

msg
string
必須

ステータス説明

result
object