ファイルカテゴリのフィールドを追加
curl --request POST \
--url https://docflow.textin.ai/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": [
"インボイス 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"
}
}
}
],
"table_id": "<string>",
"with_detail": true
}
'import requests
url = "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add"
payload = {
"workspace_id": "1234567890",
"category_id": "1234567890",
"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" }
}
}
],
"table_id": "<string>",
"with_detail": True
}
headers = {
"x-ti-app-id": "<api-key>",
"x-ti-secret-code": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-ti-app-id': '<api-key>',
'x-ti-secret-code': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workspace_id: '1234567890',
category_id: '1234567890',
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'}
}
}
],
table_id: '<string>',
with_detail: true
})
};
fetch('https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspace_id' => '1234567890',
'category_id' => '1234567890',
'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'
]
]
]
],
'table_id' => '<string>',
'with_detail' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-ti-app-id: <api-key>",
"x-ti-secret-code: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add"
payload := strings.NewReader("{\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"fields\": [\n {\n \"name\": \"インボイスコード\",\n \"description\": \"インボイスコードの説明\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"インボイス No.\",\n \"請求書番号\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"VAT 専用インボイス\",\n \"VAT 一般インボイス\",\n \"電子インボイス\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n }\n }\n ],\n \"table_id\": \"<string>\",\n \"with_detail\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-ti-app-id", "<api-key>")
req.Header.Add("x-ti-secret-code", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add")
.header("x-ti-app-id", "<api-key>")
.header("x-ti-secret-code", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"fields\": [\n {\n \"name\": \"インボイスコード\",\n \"description\": \"インボイスコードの説明\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"インボイス No.\",\n \"請求書番号\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"VAT 専用インボイス\",\n \"VAT 一般インボイス\",\n \"電子インボイス\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n }\n }\n ],\n \"table_id\": \"<string>\",\n \"with_detail\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ti-app-id"] = '<api-key>'
request["x-ti-secret-code"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"fields\": [\n {\n \"name\": \"インボイスコード\",\n \"description\": \"インボイスコードの説明\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"インボイス No.\",\n \"請求書番号\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"VAT 専用インボイス\",\n \"VAT 一般インボイス\",\n \"電子インボイス\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n }\n }\n ],\n \"table_id\": \"<string>\",\n \"with_detail\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}ファイルカテゴリ
ファイルカテゴリのフィールドを追加
指定したファイルカテゴリ配下に複数のフィールドを追加します。全件成功または全件失敗のセマンティクスを採用しており、いずれかのフィールドが検証に失敗するとバッチ全体が失敗します。
POST
/
api
/
app-api
/
sip
/
platform
/
v2
/
category
/
fields
/
batch_add
ファイルカテゴリのフィールドを追加
curl --request POST \
--url https://docflow.textin.ai/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": [
"インボイス 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"
}
}
}
],
"table_id": "<string>",
"with_detail": true
}
'import requests
url = "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add"
payload = {
"workspace_id": "1234567890",
"category_id": "1234567890",
"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" }
}
}
],
"table_id": "<string>",
"with_detail": True
}
headers = {
"x-ti-app-id": "<api-key>",
"x-ti-secret-code": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-ti-app-id': '<api-key>',
'x-ti-secret-code': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workspace_id: '1234567890',
category_id: '1234567890',
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'}
}
}
],
table_id: '<string>',
with_detail: true
})
};
fetch('https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspace_id' => '1234567890',
'category_id' => '1234567890',
'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'
]
]
]
],
'table_id' => '<string>',
'with_detail' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-ti-app-id: <api-key>",
"x-ti-secret-code: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add"
payload := strings.NewReader("{\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"fields\": [\n {\n \"name\": \"インボイスコード\",\n \"description\": \"インボイスコードの説明\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"インボイス No.\",\n \"請求書番号\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"VAT 専用インボイス\",\n \"VAT 一般インボイス\",\n \"電子インボイス\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n }\n }\n ],\n \"table_id\": \"<string>\",\n \"with_detail\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-ti-app-id", "<api-key>")
req.Header.Add("x-ti-secret-code", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add")
.header("x-ti-app-id", "<api-key>")
.header("x-ti-secret-code", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"fields\": [\n {\n \"name\": \"インボイスコード\",\n \"description\": \"インボイスコードの説明\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"インボイス No.\",\n \"請求書番号\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"VAT 専用インボイス\",\n \"VAT 一般インボイス\",\n \"電子インボイス\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n }\n }\n ],\n \"table_id\": \"<string>\",\n \"with_detail\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://docflow.textin.ai/api/app-api/sip/platform/v2/category/fields/batch_add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-ti-app-id"] = '<api-key>'
request["x-ti-secret-code"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspace_id\": \"1234567890\",\n \"category_id\": \"1234567890\",\n \"fields\": [\n {\n \"name\": \"インボイスコード\",\n \"description\": \"インボイスコードの説明\",\n \"prompt\": \"<string>\",\n \"use_prompt\": true,\n \"alias\": [\n \"インボイス No.\",\n \"請求書番号\"\n ],\n \"identity\": \"invoice_number\",\n \"multi_value\": true,\n \"duplicate_value_distinct\": true,\n \"transform_settings\": {\n \"datetime_settings\": {\n \"format\": \"yyyy-MM-dd\"\n },\n \"enumerate_settings\": {\n \"items\": [\n \"VAT 専用インボイス\",\n \"VAT 一般インボイス\",\n \"電子インボイス\"\n ]\n },\n \"regex_settings\": {\n \"match\": \"^(\\\\d{4})-(\\\\d{2})-(\\\\d{2})$\",\n \"replace\": \"$1/$2/$3\"\n },\n \"mismatch_action\": {\n \"default_value\": \"N/A\"\n }\n }\n }\n ],\n \"table_id\": \"<string>\",\n \"with_detail\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
]
}ボディ
application/json
⌘I