製品アップデートステータスページWorkato Academy
English
日本語
無料で開始
Developer API
エンドポイント

Developer API - Data tables ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

APIを使用してdata tablesとそのレコードをプログラムで管理するには、次のセクションを参照してください:

レート制限 ​

Data tablesリソースには、次のレート制限があります:

タイプリソースクォータ
すべてすべてのData tablesエンドポイント1分あたり60リクエスト

データセンターのベースURL ​

各データセンター（DC）には専用のベースURLがあります。ワークスペースのリージョンに一致するベースURLを使用します。サンプルリクエストでデータセンターを選択し、対応するベースURLに置き換えます。

次の例は、各データセンター用に変更されたdata-tablesベースURLを示しています:

データセンターベースURL
UShttps://data-tables.workato.com
EUhttps://data-tables.eu.workato.com
JPhttps://data-tables.jp.workato.com
SGhttps://data-tables.sg.workato.com
AUhttps://data-tables.au.workato.com
ILhttps://data-tables.il.workato.com
CNhttps://data-tables.workatoapp.cn
KRhttps://data-tables.kr.workato.com
UKhttps://data-tables.uk.workato.com
Trialhttps://data-tables.trial.workato.com

ワークスペースのデータセンターと一致しないエンドポイントを呼び出すと、Workatoは403 Forbiddenエラーを返します。

VIRTUAL PRIVATE WORKATO (VPW)のお客様

このページでは、すべてのWorkatoユーザー向けの一般的なガイダンスを提供します。 Virtual Private Workato (VPW)のお客様は、お客様のインスタンスに固有の詳細な設定ガイダンスについて、プライベートドキュメントを参照してください。

テーブル管理API ​

次のエンドポイントを使用してデータテーブルを管理および構成できます。

ベースURL:

https://YOUR_DATA_CENTER/api

リージョン別ベースURL

ワークスペースのリージョンに対応する専用のベースURLを使用する必要があります。詳細については、データセンターURLを参照してください。

クイックリファレンス ​

タイプリソース説明
GET/api/data_tablesすべてのデータテーブルを一覧表示します。
GET/api/data_tables/:data_table_idIDでデータテーブルを取得します。
POST/api/data_tablesデータテーブルを作成します。
PUT/api/data_tables/:data_table_idデータテーブルを更新します。
DELETE/api/data_tables/:data_table_idデータテーブルを削除します。
POST/api/data_tables/:data_table_id/truncateデータテーブルを空にします。

データテーブルを一覧表示 ​

ワークスペース内のすべてのデータテーブルの一覧を返します。

GET https://YOUR_DATA_CENTER/api/data_tables

URLパラメータ ​

名前タイプ説明
pageinteger
optional		取得するData tablesのページ番号。デフォルトは1です。
ページあたりinteger
optional		ページサイズ。デフォルトは100です。最大は100です。

サンプルリクエスト ​

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/data_tables'
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

サンプルレスポンスを表示
json
{
    "data": [
        {
            "id": "f4d2e85d-c7f4-4877-8f16-6643a4b3fb23",
            "name": "Resume screening",
            "schema": [
                {
                    "type": "string",
                    "name": "application_id",
                    "optional": true,
                    "field_id": "8f4a57d6-f524-47f2-ae59-be1a80dc2dd5",
                    "hint": "Greenhouse application ID",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "candidate_id",
                    "optional": true,
                    "field_id": "b3f6f50a-6431-4cd4-af2c-f88a7b291bce",
                    "hint": "Greenhouse candidate ID",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "job_id",
                    "optional": true,
                    "field_id": "cdf319f0-2bde-4048-bde6-4c862e7737bd",
                    "hint": "Greenhouse job ID",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "department",
                    "optional": true,
                    "field_id": "25256ad2-5297-46e3-960b-f340af9d292f",
                    "hint": "Hiring department",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "recruiter",
                    "optional": true,
                    "field_id": "38a85051-a12c-4f0b-a308-7e8cd5c68e78",
                    "hint": "Recruiter name",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "task_name",
                    "optional": true,
                    "field_id": "a305f5b1-df86-4f3f-a434-db142c9f5b95",
                    "hint": "Workflow stage",
                    "metadata": {},
                    "multivalue": false
                }
            ],
            "folder_id": 24468824,
            "created_at": "2025-04-04T11:35:04.544-07:00",
            "updated_at": "2025-04-04T11:55:50.473-07:00"
        },
        {
            "id": "fb0b03f3-2e5a-4a05-a483-4ee3092805c5",
            "name": "Intake form",
            "schema": [
                {
                    "type": "string",
                    "name": "Description",
                    "optional": true,
                    "field_id": "b3545fa7-600c-4ed0-ab04-6e4a866db158",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "Review comments",
                    "optional": true,
                    "field_id": "9db1ae98-01f2-4da5-9003-058d8ce80475",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "number",
                    "name": "Rate",
                    "optional": true,
                    "field_id": "7b98b819-f8bc-4376-9eb1-ef18c5ca9ae1",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "Notes",
                    "optional": true,
                    "field_id": "35885b91-ee7e-453e-a4f9-d41c88e74521",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "boolean",
                    "name": "pass",
                    "optional": true,
                    "field_id": "4b0f3ac7-0dad-4628-85a8-85583c9a09d9",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "Reviewer",
                    "optional": true,
                    "field_id": "a1913ee5-6342-4176-8e25-8c4787286fee",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "file",
                    "name": "Resume",
                    "optional": true,
                    "field_id": "8853cfa6-9e69-4b57-98cb-5264497b1dac",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "Email",
                    "optional": true,
                    "field_id": "fea109b6-95c2-41a9-9075-000aa4e54b6a",
                    "metadata": {},
                    "multivalue": false
                }
            ],
            "folder_id": 21138015,
            "created_at": "2024-10-04T08:40:24.349-07:00",
            "updated_at": "2025-04-03T10:02:37.905-07:00"
        },
        {
            "id": "d263710a-e7cc-418f-bbc5-aacf76667418",
            "name": "PTO requests",
            "schema": [
                {
                    "type": "string",
                    "name": "Name",
                    "optional": false,
                    "field_id": "4cd59a12-ae0c-40fa-8896-fd259b271fd9",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "Description",
                    "optional": true,
                    "field_id": "06e65f37-81eb-4093-8219-f8b14b2b23e8",
                    "metadata": {},
                    "multivalue": false
                },
                {
                    "type": "string",
                    "name": "Review comments",
                    "optional": true,
                    "field_id": "cb1589c6-2537-43f8-bd5d-6776b310d080",
                    "metadata": {},
                    "multivalue": false
                }
            ],
            "folder_id": 17415752,
            "created_at": "2024-09-26T20:49:04.147-07:00",
            "updated_at": "2024-09-26T20:49:04.222-07:00"
        }
    ]
}

IDでデータテーブルを取得 ​

指定したIDに対応するデータテーブルを返します。

GET https://YOUR_DATA_CENTER/api/data_tables/:data_table_id

URLパラメータ ​

名前タイプ説明
data_table_idinteger
required		特定のデータテーブルのIDを指定します。

サンプルリクエスト ​

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/data_tables/:data_table_id'
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "data": {
        "id": "db4b8544-8de8-4c6d-83bd-e487f6616ccc",
        "name": "Expense reports",
        "schema": [
            {
                "type": "string",
                "name": "Expense type",
                "optional": false,
                "field_id": "1ec0c3c7-abcd-4bca-bab5-efa51da56635",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "number",
                "name": "Cost",
                "optional": true,
                "field_id": "b3545fa7-600c-4ed0-ab04-6e4a866db158",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "date",
                "name": "Date of purchase",
                "optional": true,
                "field_id": "9db1ae98-01f2-4da5-9003-058d8ce80475",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "integer",
                "name": "Priority",
                "optional": true,
                "field_id": "7b98b819-f8bc-4376-9eb1-ef18c5ca9ae1",
                "metadata": {},
                "multivalue": false
            },
        ],
        "folder_id": 1124996,
        "created_at": "2025-05-16T13:30:09.835+08:00",
        "updated_at": "2025-05-16T13:30:09.835+08:00"
    }
}

レコードインポートステータス ​

レスポンスには、レコードインポートが進行中の間と、完了後24時間まで、または削除されるまで、records_import_status オブジェクトも含まれます。自動化パイプラインはこのオブジェクトを使用して、インポートの失敗を検出できます。

名前タイプ説明
filenamestringインポート開始時に指定したファイル名。
total_bytesintegerファイルの合計サイズ（バイト単位）。
total_recordsintegerファイル内のレコードの合計数。
statusstringin_progress、completed、failed などのインポートステータス。
processed_recordsintegerこれまでに処理されたレコード数。
etastring完了予定時刻。 status が in_progress のときに表示されます。
completed_atstringインポートが完了した時刻。 status が completed のときに表示されます。
failed_atstringインポートが失敗した時刻。 status が failed のときに表示されます。
is_internal_errorboolean失敗がインポートされたデータのエラーではなく、Workatoの内部エラーによるものかどうかを示します。 status が failed のときに表示されます。
errorstring失敗内容の人間が読める説明。 status が failed のときに表示されます。
error_record_idxinteger失敗の原因となったレコードの0始まりのインデックス。 status が failed のときに表示されます。
error_detailsobject失敗に関する詳細を含みます。 status が failed のときに表示されます。可能な値については、エラーコードを参照してください。

次の例は、インポートが完了した場合の例です。

json
{
  "data": {
    "records_import_status": {
      "filename": "bank_report.csv",
      "total_bytes": 3005,
      "total_records": 18,
      "status": "completed",
      "processed_records": 18,
      "completed_at": "2026-07-09T17:44:42.877+00:00"
    }
  }
}
エラーコード ​

status が failed の場合、レスポンスには error_details オブジェクトが含まれ、その中の error_code フィールドに次のいずれかの値が設定されます。

エラーコード追加フィールド説明
MAX_TABLE_SIZE_EXCEEDEDmax_table_size_bytesインポートによってテーブルサイズの上限を超えます。
MAX_NUM_RECORDS_EXCEEDEDmax_num_recordsインポートによってテーブルあたりのレコード数の上限を超えます。
MAX_DOCUMENT_SIZE_EXCEEDEDmax_document_size_bytesあるレコードが最大レコードサイズの上限を超えます。
TEXT_VALUE_TOO_LONGfield_id, field_name, max_text_value_charsテキスト値が、そのフィールドに許可されている最大文字数を超えています。

制限

インポートに適用されるサイズおよびレコード数のクォータについては、Data tables - Quotasを参照してください。

失敗したインポートの例

次の例では、description フィールドのテキスト値がそのフィールドに許可されている最大文字数を超えているため、インポートが失敗しています。

json
{
  "data": {
    "records_import_status": {
      "filename": "bank_report.csv",
      "total_bytes": 15295,
      "total_records": 1,
      "status": "failed",
      "processed_records": 0,
      "failed_at": "2026-07-13T17:05:10.565+00:00",
      "is_internal_error": false,
      "error": "value in field \"description\": text is too long (15000 characters, max allowed: 10000)",
      "error_record_idx": 0,
      "error_details": {
        "error_code": "TEXT_VALUE_TOO_LONG",
        "field_id": "4b01d22e-b888-4d1d-b90c-7c78ad75424d",
        "field_name": "description",
        "max_text_value_chars": 10000
      }
    }
  }
}

データテーブルを作成 ​

指定したフォルダにデータテーブルを作成します。

POST https://YOUR_DATA_CENTER/api/data_tables

ペイロード ​

名前タイプ説明
namestring
必須		作成するデータテーブルの名前。
folder_idinteger
required		データテーブルを作成する予定のフォルダのIDを指定します。
schemaarray
必須		テーブル構造を定義するために、入れ子要素の配列を指定します。列名、データ型、および列が必須かどうかを指定する必要があります。
schema[type]boolean、date、date_time、integer、number、string、file、relation
必須		作成する列のデータ型。
schema[name]string
必須		作成する列の名前。
schema[optional]integer、boolean
必須		列が必須か任意かを示します。 true、false、1、0 のいずれかである必要があります。
schema[field_id]正規表現 /\h{8}-\h{4}-\h{4}-\h{4}-\h{12}/ に一致している必要があります。
任意		列のUUID（Universally Unique Identifier）。次の形式に従う必要があります: f47ac10b-58cc-4372-a567-0e02b2c3d479.
schema[hint]string
optional		エンドユーザーがデータ列の値を入力しやすくなるようにヒントを指定します。ヒントは、ユーザーインターフェースで列にカーソルを合わせたときのツールチップとして表示されます。
schema[default_value]variable
任意		列のデフォルト値。リクエストで指定した列のデータ型と一致している必要があります。
schema[metadata]hash
任意		データテーブルのメタデータ。
schema[relation]hash
任意		このテーブルが別のデータテーブルにリンクしていることを示します。
schema[relation][table_id]string
optional		このテーブルにリンクされているデータテーブルのID。
schema[relation][field_id]string
必須		リンク先データテーブルの列ID。
schema[multivalue]boolean 任意列が複数値の入力を受け付けるかどうかを示します。

サンプルリクエスト ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/data_tables' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "name": ":name",
            "folder_id": :folder_id_value,
            "schema": [
                {
                    "type": ":type",
                    "name": ":name",
                    "optional": :true_or_false,
                    "multivalue": :true_or_false,
                    "relation": {
                        "table_id": ":table_id",
                        "field_id": ":field_id"
                    }
            ]
      }

レスポンス ​

json
{
    "data": {
        "id": "52d97443-1dbd-4ae0-9cd9-99ac2d020977",
        "name": "Expense reports 4",
        "schema": [
            {
                "type": "string",
                "name": "Expense type",
                "optional": false,
                "field_id": "76ddbd6f-35ea-4884-bb97-cecac5d4abc7",
                "metadata": {},
                "multivalue": true,
                "relation": {
                    "table_id": "2507a39a-6847-4857-88ed-c3b9c8302e02",
                    "field_id": "900454f4-5b3d-4670-bc3c-d640915156f2"
            }}
        ]
    }
}

データテーブルを更新 ​

指定したデータテーブルを更新します。

PUT https://YOUR_DATA_CENTER/api/data_tables/:data_table_id

URLパラメータ ​

名前タイプ説明
data_table_idstring更新するデータテーブルのID。データテーブルを一覧表示エンドポイントを使用して、データテーブルIDを取得できます。

ペイロード ​

名前タイプ説明
namestring
必須		作成するデータテーブルの名前。
folder_idstring
optional		データテーブルを作成する予定のフォルダのIDを指定します。
schemaarray
必須		テーブル構造を定義するために、入れ子要素の配列を指定します。列名、データ型、および列が必須かどうかを指定する必要があります。
schema[type]boolean、date、date_time、integer、number、string、file、relation
必須		作成する列のデータ型。
schema[name]string
必須		作成する列の名前。
schema[optional]integer、boolean
必須		列が必須か任意かを示します。 true、false、1、0 のいずれかである必要があります。
schema[field_id]正規表現 /\h{8}-\h{4}-\h{4}-\h{4}-\h{12}/ に一致している必要があります。
任意		列のUUID（Universally Unique Identifier）。次の形式に従う必要があります: f47ac10b-58cc-4372-a567-0e02b2c3d479.
schema[hint]string
optional		エンドユーザーがデータ列の値を入力しやすくなるようにヒントを指定します。ヒントは、ユーザーインターフェースで列にカーソルを合わせたときのツールチップとして表示されます。
schema[default_value]variable
任意		列のデフォルト値。リクエストで指定した列のデータ型と一致している必要があります。
schema[metadata]hash
任意		データテーブルのメタデータ。
schema[relation]hash
任意		このテーブルが別のデータテーブルにリンクしていることを示します。
schema[relation][table_id]string
optional		このテーブルにリンクされているデータテーブルのID。
schema[relation][field_id]string
必須		リンク先データテーブルの列ID。
schema[multivalue]boolean 任意列が複数値の入力を受け付けるかどうかを示します。

サンプルリクエスト ​

shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/data_tables/:data_table_id' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "name": ":name",
            "folder_id": :folder_id_value,
            "schema": [
                {
                    "type": ":type",
                    "name": ":name",
                    "optional": :true_or_false,
                    "multivalue": :true_or_false,
                    "relation": {
                        "table_id": ":table_id",
                        "field_id": ":field_id"
                    }
            ]
      }

レスポンス ​

json
{
    "data": {
        "id": "52d97443-1dbd-4ae0-9cd9-99ac2d020977",
        "name": "Expense reports updated",
        "schema": [
            {
                "type": "string",
                "name": "Expense type",
                "optional": false,
                "field_id": "318b18ca-bb5f-426c-adb1-74eb2fc06641",
                "default_value": [],
                "metadata": {},
                "multivalue": true
            },
            {
                "type": "date",
                "name": "Date",
                "optional": true,
                "field_id": "97a960ee-022b-4a69-bcdb-74bb4c3d524d",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "boolean",
                "name": "Status",
                "optional": true,
                "field_id": "66b7f251-b874-4d87-a974-c18260a6a8fb",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "date_time",
                "name": "Check-in",
                "optional": true,
                "field_id": "6c119dad-3d08-427d-bac2-27536aedebad",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "file",
                "name": "Reciept",
                "optional": true,
                "field_id": "a6e5360f-5b5e-4261-9967-4160bd80e1a0",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "integer",
                "name": "Length of stay in days",
                "optional": true,
                "field_id": "bea282f0-fc78-4847-b7c8-a93587835faa",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "number",
                "name": "Cost",
                "optional": true,
                "field_id": "7d438888-5e04-4b70-b7b1-e54cdc42e877",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "relation",
                "name": "Budget",
                "optional": true,
                "field_id": "ebe23be4-d388-42fd-922b-0fb4e57abc08",
                "metadata": {},
                "relation": {
                    "table_id": "2507a39a-6847-4857-88ed-c3b9c8302e02",
                    "field_id": "900454f4-5b3d-4670-bc3c-d640915156f2"
                },
                "multivalue": false
            }
        ],
        "folder_id": 75509,
        "created_at": "2025-05-21T14:56:49.173-07:00",
        "updated_at": "2025-05-21T15:36:23.701-07:00"
    }
}

データテーブルを削除 ​

指定したデータテーブルを削除します。

DELETE https://YOUR_DATA_CENTER/api/data_tables/:data_table_id

URLパラメータ ​

名前タイプ説明
data_table_idinteger
required		データテーブルID。

サンプルリクエスト ​

shell
curl -X DELETE 'https://YOUR_DATA_CENTER/api/data_tables/:data_table_id'
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "data": {
        "status": "success"
    }
}

データテーブルを空にする ​

指定したデータテーブルを空にします。データテーブルを空にすると、テーブルの構造は維持したまま、データテーブル内のすべてのデータが削除されます。

POST https://YOUR_DATA_CENTER/api/data_tables/:data_table_id/truncate

URLパラメータ ​

名前タイプ説明
data_table_idinteger
required		データテーブルID。

サンプルリクエスト ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/data_tables/:data_table_id/truncate'
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "data": {
        "status": "success"
    }
}

レコード操作API ​

次のエンドポイントを使用して、データテーブルレコードの作成、削除、および更新を行うことができます。データセンターのベースURL上の /api/v1/openapi.json にあるOpenAPI仕様を参照してください。

ベースURL:

https://YOUR_DATA_TABLES_DC/api

リージョン別ベースURL

ワークスペースのリージョンに対応する専用のベースURLを使用する必要があります。詳細については、データセンターURLを参照してください。

クイックリファレンス ​

タイプリソース説明
POST/api/v1/tables/:data_table_id/query指定したフィルタを使用してレコードをクエリします。
POST/api/v1/tables/:data_table_id/records新しいレコードを作成します。
PUT/api/v1/tables/:data_table_id/records/:record_id既存のレコードを更新します。
DELETE/api/v1/tables/:data_table_id/records/:record_id指定したレコードを削除します。
POST/api/v1/tables/:data_table_id/fields/:field_id/fileファイルをアップロードするためのリンクを生成します。
GET/api/v1/tables/:data_table_id/records/:record_id/fields/:field_id/fileファイルをダウンロードするためのリンクを生成します。

レコードをクエリ (v1) ​

指定したフィルタに基づいて、データテーブル内のレコードをクエリします。

POST https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/query

URLパラメータ ​

名前タイプ説明
data_table_idstring更新するデータテーブルのID。データテーブルを一覧表示エンドポイントを使用して、データテーブルIDを取得できます。

ペイロード ​

名前タイプ説明
selectarray
optional		データテーブルから取得する列の一覧を指定します。
wherehash
任意		レコードをフィルタリングする条件セット。詳細については、where句セクションを参照してください。
orderstring または hash
任意		結果を並べ替える列。単純な場合は string、より高度な並べ替え設定には hash を指定します。 hash 構造の詳細な内訳は後述します。
timezone_offset_secsinteger
optional		クエリに使用するタイムゾーンオフセット。クエリで日時フィールドと日付値を比較する場合に必須です。
limitinteger
optional		1ページあたりに返すレコード数を制限します。最大値は200です。
continuation_tokenstring
optional		同じクエリの次の結果セットを取得するために、前のページのリクエストで返された次ページトークンを指定します。

INFO

作成したフィールドに加えて、order パラメータでは次のメタフィールドを使用できます: $record_id、$created_at、$updated_at.

where フィールド構造 ​

基本的な where 句は次の形式を使用します。

{ <field>: { <operator>: <value> } }

<value> にはプリミティブ値またはオブジェクトを設定できます。

次の表に、使用可能な operator の値を示します。

Operator説明例
$eq等しい{ "name": { "$eq": "Josh" } }
$ne等しくない{ "status": { "$ne": "inactive" } }
$gte以上なら{ "score": { "$gte": 75 } }
$gtより大きい{ "score": { "$gt": 90 } }
$lte以下{ "amount": { "$lte": 13 } }
$ltより小さい{ "amount": { "$lt": 10 } }
$inIn（<value> 内のいずれかの値と一致するレコードを返します）{ "name": { "$in": ["Josh", "Bob", "Alice"] } }
$starts_withで開始する{ "email": { "$starts_with": "admin@" } }
複合条件 ​

$and 複合演算子を使用して、{ "$and": [ <condition1>, <condition2>, ... ] } という形式で複数の条件を組み合わせることができます。例:

json
{
  "$and": [
    {
      "name": "Josh"
    },
    {
      "id": {
        "$lte": 13
      }
    }
  ]
}

また、$and 演算子と同等の省略記法を使用することもできます。例:

json
{
  "name": "Josh",
  "id": { "$lte": 13 }
}
order フィールドのハッシュ構造 ​

order フィールドに hash を指定する場合は、次の構造を使用する必要があります。

json
{
  "by": <field>,
  "direction": "asc" | "desc",
  "case_sensitive": true | false
}

サンプルリクエスト ​

shell
curl  -X POST 'https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/query' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "select": [":select_column_1", ":select_column_2"],
            "where":
                {
                    ":where_field_1": { "$gt": :where_value_1 },
                    ":where_field_2": ":where_value_2"
                },
            "order": ":order",
            "limit": :limit_value,
            "timezone_offset_secs": :timezone_offset_secs_value
        }'

レスポンス ​

json
{
  "schema": [
    [ // Metafields
      { "name": "$record_id" },
      { "name": "$created_at" },
      { "name": "$updated_at" }
    ],
    [ // Fields
      { "name": "Name", "id": "2507a39a-6847-4857-88ed-c3b9c8302e02" },
      { "name": "Address", "id": "4705a22b-9139-6482-332a-ca2dd2d03sd3" },
      ...
    ]
  ],
  "data": [
    [ // Record 1
      [ // Metafields
        "e9498300-1ea3-4bf0-bdea-ffe58c101bcf",
        "2025-08-19T17:53:48.073+00:00",
        "2025-08-19T17:53:48.073+00:00"
      ],
      [ // Fields
        "Ann-Marie Tan",
        "5 Pennsylvania Ave. S320123"
      ]
    ],
    [ // Record 2
      [ // Metafields
        "900454f4-5b3d-4670-bc3c-d640915156f2",
        "2025-08-19T17:53:48.073+00:00",
        "2025-08-19T17:53:48.073+00:00"
      ],
      [ // Fields
        "John Paul Lim",
        "8 Somapah Road S210492"
      ]
    ],
    ...
  ],
  "count": 2,
  "limit": 10
}

レコードを作成 (v1) ​

指定したデータテーブルにレコードを作成します。

POST https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records

URLパラメータ ​

名前タイプ説明
data_table_idstringレコードを作成するデータテーブルのID。データテーブルを一覧表示エンドポイントを使用して、データテーブルIDを取得できます。

ペイロード ​

リクエストペイロードの構造は、各フィールドのキーと値のペアです。フィールドはUUID（ドル記号を付けたもの）または名前で指定できます。スキーマに含まれているが指定されていないフィールドには、デフォルト値が使用されます。スキーマに含まれていない余分なフィールドは無視されます。

サンプルリクエスト ​

shell
curl  -X POST 'https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "document":
            {
                ":field_name_1": ":field_value_1",
                ":field_name_2": :field_value_2,
                ":$field_id_uuid": :field_value_3,
                ":field_name_date": ":field_value_date",
                ":field_name_relation":
                    {
                        "record_id": ":record_id"
                    },
                ":field_name_file":
                    {
                        "filename": ":filename",
                        "upload_id": ":upload_id"
                    }
            }
        }'

レスポンス ​

json
{
    "data": {
        "record_id": "ab0189ca-fadf-4382-a48b-e157d966078f",
        "created_at": "2025-07-10T15:55:02.661+00:00",
        "updated_at": "2025-07-10T15:55:02.661+00:00",
        "document": [
            {
                "field_id": "42d62e3b-895d-43db-b8f7-cbb62dac71dd",
                "field_name": "name",
                "value": "Josh"
            },
            {
                "field_id": "2dca773b-eb67-4201-924d-4ccb9d577e99",
                "field_name": "multivalue",
                "value": [1,2,3]
            },
            {
                "field_id": "28c00d59-7dbe-4134-85be-937513500500",
                "field_name": "age",
                "value": 13
            },
            {
                "field_id": "0489bb65-7072-404f-9bba-e3e94a2a527b",
                "field_name": "date",
                "value": "2022-02-01"
            },
            {
                "field_id": "d6f103d9-575f-41b9-9ef0-b70e8fe38cc8",
                "field_name": "relation",
                "value": {
                    "record_id": "7a13304c-14cf-4e98-be31-331ccdb2b253",
                    "value": "Parent"
                },
            },
            {
                "field_id": "f71f1f67-0de5-422c-be73-b27b12f442c4",
                "field_name": "file",
                "value": {
                    "filename": "birth_certificate.txt"
                },
            }
        ]
    }
}

レコードを更新 (v1) ​

指定したデータテーブル内のレコードを更新します。

PUT https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/:record_id

URLパラメータ ​

名前タイプ説明
data_table_idstringレコードが存在するデータテーブルのID。データテーブルを一覧表示エンドポイントを使用して、データテーブルIDを取得できます。
record_idstring更新対象レコードのID。

ペイロード ​

リクエストペイロードの構造は、各フィールドのキーと値のペアです。フィールドはUUID（ドル記号を付けたもの）または名前で指定できます。スキーマに含まれていても指定されていないフィールドは更新されません。スキーマに含まれていない余分なフィールドは無視されます。

サンプルリクエスト ​

shell
curl  -X PUT 'https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/:record_id' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "document":
            {
                ":field_name_1": ":field_value_1",
                ":field_name_2": :field_value_2,
                ":$field_id_uuid": :field_value_3,
                ":field_name_date": ":field_value_date",
                ":field_name_relation":
                    {
                        "record_id": ":record_id"
                    },
                ":field_name_file":
                    {
                        "filename": ":filename",
                        "upload_id": ":upload_id"
                    }
            }
        }'

レスポンス ​

json
{
    "data": {
        "record_id": "ab0189ca-fadf-4382-a48b-e157d966078f",
        "created_at": "2025-07-10T15:55:02.661+00:00",
        "updated_at": "2025-07-10T15:55:02.661+00:00",
        "document": [
            {
                "field_id": "42d62e3b-895d-43db-b8f7-cbb62dac71dd",
                "field_name": "name",
                "value": "Josh"
            },
            {
                "field_id": "2dca773b-eb67-4201-924d-4ccb9d577e99",
                "field_name": "multivalue",
                "value": [1,2,3]
            },
            {
                "field_id": "28c00d59-7dbe-4134-85be-937513500500",
                "field_name": "age",
                "value": 13
            },
            {
                "field_id": "0489bb65-7072-404f-9bba-e3e94a2a527b",
                "field_name": "date",
                "value": "2022-02-01"
            },
            {
                "field_id": "d6f103d9-575f-41b9-9ef0-b70e8fe38cc8",
                "field_name": "relation",
                "value": {
                    "record_id": "7a13304c-14cf-4e98-be31-331ccdb2b253",
                    "value": "Parent"
                },
            },
            {
                "field_id": "f71f1f67-0de5-422c-be73-b27b12f442c4",
                "field_name": "file",
                "value": {
                    "filename": "birth_certificate.txt"
                },
            }
        ]
    }
}

レコードを削除 (v1) ​

指定したデータテーブル内のレコードを削除します。

DELETE https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/:record_id

URLパラメータ ​

名前タイプ説明
data_table_idstringレコードが存在するデータテーブルのID。データテーブルを一覧表示エンドポイントを使用して、データテーブルIDを取得できます。
record_idstring更新対象レコードのID。

サンプルリクエスト ​

shell
curl -X DELETE 'https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/:record_id'
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

削除が成功すると、Workatoはレスポンスペイロードなしでステータスコード 200 を返します。

ファイル型の列に対してファイルをアップロードするためのリンクを生成します。レコードの作成または更新時に、ここで得られた upload_id を使用します。

POST https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/fields/:field_id/file
名前タイプ説明
data_table_idstringレコードが存在するデータテーブルのID。データテーブルを一覧表示エンドポイントを使用して、データテーブルIDを取得できます。
field_idstringアップロード対象ファイルのファイル列のID。
shell
curl  -X POST 'https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/fields/:field_id/file' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json'
json
{
  "data" : {
    "upload_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "url": "https://file-storage.workato.com/sharing/files?sign=eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9.eyJpc3MiOiJXb3JrYXRvRmlsZXMiLCJhdWQiOiJ3b3JrYXRvX2ZpbGVzIiwiZXhwIjoxNzUzOTUzNTUzLCJuYmYiOjE3NTM5NTI2NTMsInN1YiI6IjY5MjY1OCIsImp0aSI6IjBmMzY4N2EyLTUzNGUtNGIxMC1iODQzLTk4NmU1MWI2YTI1MCIsIm9iaiI6eyJtZXRob2QiOiJHRVQiLCJyZXNvdXJjZSI6ImY0YWE3OWU0MjlhZjNjNGRhNTcwMGU0NTYxMTY3MzM2ZjMzOTJmNzNkZDQ0ZjhjMGExMTk4MDI5MmViNzE2NjMiLCJjb25zdHJhaW50cyI6eyJmaWxlX21heF9ieXRlcyI6bnVsbCwiZmlsZV9wYXRoIjoiL1Rlc3RpbmcvMi1zdGVwLWxvZ2luLWVucm9sbG1lbnQyMDI1LTA2LTI3VDAyMzE0Ni5odG1sIiwiZmlsZV90dGwiOm51bGwsIm5hbWVzcGFjZSI6ImFkYXB0ZXIiLCJzaGFyaW5nX2FwaV9raW5kIjoicHVibGljIiwidXNlcl9pZCI6NjkyNjU4fX19.0p-NuNaQxCs_VaTaWsQGg5aS3BwCGSrHSQOVh5xb-jXQAaHAv_RSnUs6ymV9IHMVZM2P1ikodSDGtyn7pqZItw"
  }
}

レコードからファイルをダウンロード (v1) ​

レコードのファイル型列にあるファイルをダウンロードするためのリンクを生成します。

GET https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/:record_id/fields/:field_id/file

URLパラメータ ​

名前タイプ説明
data_table_idstringレコードが存在するデータテーブルのID。データテーブルを一覧表示エンドポイントを使用して、データテーブルIDを取得できます。
record_idstringファイルにリンクされているレコードのID。
field_idstringダウンロード対象ファイルのファイル列のID。

サンプルリクエスト ​

shell
curl -X GET 'https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/:record_id/fields/:field_id/file'
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

リクエストが成功すると、Workatoは LOCATION ヘッダー内にダウンロードURLを含むステータスコード 303 を返します。

レコードインポートAPI ​

次のエンドポイントを使用して、ファイルからデータテーブルにレコードをインポートできます。

次の例は、一般的なインポートフローを示しています。

インポートフロー
1

ファイルアップロードリンクを作成して、ファイル用の署名付きURLを要求します。

2

返されたURLに対してファイルをアップロードし、リクエストボディとしてファイルの生バイトを送信します。

3

任意。アップロード済みファイルを記述して、インポート前に検出された列およびレコード数を確認します。

4

データテーブルを更新エンドポイントを使用して、足りない列をテーブルに追加します。マッピングする列は、テーブルにすでに存在している必要があります。対応する列が存在しないテーブルへのインポートは失敗します。

5

インポートを開始し、ファイル列をテーブルフィールドにマッピングします。

6

IDでデータテーブルを取得エンドポイントの records_import_status フィールドを通じて、インポートを監視します。

7

インポートを削除してインポート状態をクリアするか、キャンセルする場合は前倒しで呼び出します。

リージョン別ベースURL

ワークスペースのリージョンに対応する専用のベースURLを使用する必要があります。詳細については、データセンターURLを参照してください。

クイックリファレンス ​

タイプリソース説明
POST/api/v1/tables/:data_table_id/records/import/file/upload_linkファイルをアップロードするためのリンクを作成します。
POST/sharing/files署名付きリンクにファイルをアップロードします。
DELETE/api/v1/tables/:data_table_id/records/import/fileアップロード済みファイルを削除します。
GET/api/v1/tables/:data_table_id/records/import/fileアップロード済みファイルの内容を取得します。
POST/api/v1/tables/:data_table_id/records/import/startアップロード済みファイルからレコードのインポートを開始します。
DELETE/api/v1/tables/:data_table_id/records/importインポートを削除またはキャンセルします。

インポート用にファイルをアップロードするための署名付きリンクを作成します。

POST https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/import/file/upload_link
名前タイプ説明
data_table_idstring
必須		レコードをインポートするデータテーブルのID。データテーブルを一覧表示エンドポイントを使用して、データテーブルIDを取得できます。
名前タイプ説明
file_formathash
required		アップロードするファイルの形式。
file_format[format]string
必須		ファイル形式。現在サポートされているのは csv のみです。
file_format[has_header]boolean
必須		ファイルの1行目に列ラベルが含まれているかどうか。
file_format[delimiter]string
必須		各行内の値を区切るために使用される文字。指定できる値は comma、semicolon、space、tab、colon、pipe です。
file_format[quote]string
必須		区切り文字や改行を含む値を囲むために使用される文字。指定できる値は double と single です。
file_format[encoding]string
必須		テキストエンコーディング名。サポートされるエンコーディングは、WHATWG Encoding Standard で定義されているものです。例えば utf-8 です。
shell
curl -X POST 'https://YOUR_DATA_TABLES_DC/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/import/file/upload_link' \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "file_format": {
             "format": "csv",
             "has_header": true,
             "delimiter": "comma",
             "quote": "double",
             "encoding": "utf-8"
           }
         }'

201 Created を返し、ファイルをアップロードするために使用する署名付きWorkato FilesのURLを含みます。

json
{
  "data": {
    "url": "https://file-storage.workato.com/sharing/files?sign=<signed_token>"
  }
}
インポートがすでに進行中

このリクエストは、テーブルに対するインポートがすでに進行中であるため、次の例のように IMPORT_STATE_ERROR コードを含む 400 Bad Request エラーを返します。

json
{
  "errors": [
    { "code": "IMPORT_STATE_ERROR", "title": "import already in progress" }
  ]
}
テーブルが見つからない

このリクエストは、データテーブルが存在しないかスコープ外であるため、次の例のように 404 Not Found エラーを返します。

json
{
  "errors": [
    { "code": "TABLE_NOT_FOUND" }
  ]
}

ファイルのアップロード ​

ファイルアップロードリンクを作成で返された署名付きURLにファイルをアップロードします。このエンドポイントでは Authorization ヘッダーは不要です。 URL内の署名がリクエストを認可します。

ベースURL: ファイルアップロードリンクを作成の url フィールドで返されるホスト

POST /sharing/files

クエリパラメータ ​

名前タイプ説明
signstring
必須		ファイルアップロードリンクを作成で返された認可用の署名。

ペイロード ​

リクエストボディとしてファイルの生バイトを送信します。

サンプルリクエスト ​

shell
curl -X POST 'https://file-storage.workato.com/sharing/files?sign=<signed_token>' \
     -H 'Content-Type: text/csv' \
     --data-binary @data.csv

レスポンス ​

json
{
  "file_id": "7d1ac9a4-2a6c-4951-b97a-9ab22c722500",
  "mime_type": "text/csv",
  "path": "/csv_import.4546638.c9228d13-f394-44ff-a3a2-13e04a70ea9c.csv",
  "size": 3005,
  "version_id": null
}

アップロード済みファイルを削除 ​

インポート用にアップロードされたファイルを削除します。インポート開始前にキャンセルする場合に使用します。

DELETE https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/import/file

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		アップロードされたファイルを削除する対象のデータテーブルのID。

サンプルリクエスト ​

shell
curl -X DELETE 'https://YOUR_DATA_TABLES_DC/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/import/file' \
     -H 'Authorization: Bearer <api_token>' # DELETEリクエストを送信して取り込みファイルを削除

レスポンス ​

インポート用にアップロードされたファイルが削除されると、空のdataオブジェクトと共に200 OKが返されます。

json
{
  "data": {}
}
アップロード済みファイルなし

次の例では、インポート用のファイルがアップロードされていないため、リクエストはIMPORT_STATE_ERRORコードを含む400 Bad Requestエラーを返します。

json
{
  "errors": [
    { "code": "IMPORT_STATE_ERROR", "title": "import file not found" }
  ]
}
テーブルが見つからない

このリクエストは、データテーブルが存在しないかスコープ外であるため、次の例のように 404 Not Found エラーを返します。

json
{
  "errors": [
    { "code": "TABLE_NOT_FOUND" }
  ]
}

アップロード済みファイルの記述 ​

アップロード済みファイルで検出されたカラムとレコード数を返し、インポートを開始する前に内容を確認できるようにします。

GET https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/import/file

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		アップロード済みファイルの情報を取得する対象のデータテーブルのID。

サンプルリクエスト ​

shell
curl -X GET 'https://YOUR_DATA_TABLES_DC/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/import/file' \
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
  "data": {
    "columns": [
      {
        "column_id": "col1",
        "label": "report_date",
        "optional": false,
        "type": "date",
        "valid_types": ["date", "string"]
      },
      {
        "column_id": "col9",
        "label": "amount",
        "optional": false,
        "type": "number",
        "valid_types": ["number", "string"]
      }
    ],
    "file_format": {
      "delimiter": "comma",
      "encoding": "utf-8",
      "format": "csv",
      "has_header": true,
      "quote": "double"
    },
    "num_records": 18
  }
}
アップロード済みファイルなし

次の例では、インポート用のファイルがアップロードされていないため、リクエストはIMPORT_STATE_ERRORコードを含む400 Bad Requestエラーを返します。

json
{
  "errors": [
    { "code": "IMPORT_STATE_ERROR", "title": "import file not found" }
  ]
}
テーブルが見つからない

このリクエストは、データテーブルが存在しないかスコープ外であるため、次の例のように 404 Not Found エラーを返します。

json
{
  "errors": [
    { "code": "TABLE_NOT_FOUND" }
  ]
}

インポートの開始 ​

アップロード済みファイルからテーブルへのレコードのインポートを開始します。

前提条件

Start importエンドポイントには、次の前提条件があります。

  • Upload fileエンドポイントを使用してファイルをアップロードします。
  • ターゲット先にすべてのテーブルカラムが存在することを確認します。インポートを開始する前に、Update data tableエンドポイントを使用して、不足しているカラムを追加します。
POST https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/import/start

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		レコードをインポートするデータテーブルのID。

ペイロード ​

名前タイプ説明
filenamestring
必須		このインポートに対してUIに表示されるファイル名。
fieldsarray
必須		ファイルカラムとテーブルフィールド間のマッピング。各エントリは、1つのファイルカラムを1つのテーブルフィールドにマッピングします。必須テーブルフィールドはすべてマッピングする必要があり、カラムとフィールドのデータ型は互換性がなければなりません。
fields[field_id]string
conditional		ターゲットテーブルフィールドのID。 field_idまたはfield_nameのいずれかを指定します。
fields[field_name]string
conditional		ターゲットテーブルフィールドの名前。 field_idまたはfield_nameのいずれかを指定します。
fields[file_column_index]integer
conditional		ソースファイルカラムの0始まりインデックス。 file_column_indexまたはfile_column_labelのいずれかを指定します。
fields[file_column_label]string
conditional		ソースファイルカラムのラベル。ファイル内でカラムラベルが一意である場合にのみ使用できます。 file_column_indexまたはfile_column_labelのいずれかを指定します。
modestring
必須		インポート時の動作。受け入れ可能な値はassert_table_empty、truncate_table、appendです。詳細については、Import modesを参照してください。
インポートモード ​

次のインポートモードがサポートされています。

モード動作
assert_table_emptyテーブルが空の場合にのみインポートが実行されます。それ以外の場合は、エラーが返されます。
truncate_tableインポート前に既存のすべてのレコードが削除されます。 Truncate a data table権限が必要です。
appendテーブル内の既存レコードに対して、レコードが追記されます。

サンプルリクエスト ​

shell
curl -X POST 'https://YOUR_DATA_TABLES_DC/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/import/start' \
     -H 'Authorization: Bearer <api_token>' \
     -H 'Content-Type: application/json' \
     -d '{
           "filename": "data.csv",
           "fields": [
             { "field_name": "report_date", "file_column_label": "report_date" },
             { "field_name": "amount", "file_column_label": "amount" },
             { "field_name": "currency", "file_column_label": "currency" }
           ],
           "mode": "append"
         }'

レスポンス ​

インポートが正常に開始されると、空のdataオブジェクトと共に202 Acceptedが返されます。 Get data table by IDエンドポイントのrecords_import_statusフィールドで、インポートの進行状況を追跡します。

json
{
  "data": {}
}
インポートを開始できない

インポートを開始できない場合、リクエストはIMPORT_STATE_ERRORコードを含む400 Bad Requestエラーを返します。たとえば、ファイルがアップロードされていない場合、すでにインポートが進行中の場合、またはassert_table_emptyモードでテーブルが空でない場合などです。次の例では、テーブルが空ではありません。

json
{
  "errors": [
    { "code": "IMPORT_STATE_ERROR", "title": "table has records" }
  ]
}
互換性のないフィールドマッピング

マッピングが無効な場合、リクエストはIMPORT_SCHEMA_ERRORコードを含む400 Bad Requestエラーを返します。たとえば、不明なカラム、重複したマッピング、必須フィールドがマッピングされていない場合などです。次の例では、ファイルカラムの型がターゲットフィールドの型と一致していません。

json
{
  "errors": [
    { "code": "IMPORT_SCHEMA_ERROR", "title": "column \"Name\" (index 0) is not compatible with the type \"date\" of table field \"date_registered\" (9a2d5844-a983-43c7-b7c0-217c570b445a)" }
  ]
}
テーブルが見つからない

このリクエストは、データテーブルが存在しないかスコープ外であるため、次の例のように 404 Not Found エラーを返します。

json
{
  "errors": [
    { "code": "TABLE_NOT_FOUND" }
  ]
}

インポートの破棄 ​

インポート完了後にインポート状態を破棄するか、進行中のインポートをキャンセルします。

DELETE https://YOUR_DATA_TABLES_DC/api/v1/tables/:data_table_id/records/import

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		インポートを破棄またはキャンセルする対象のデータテーブルのID。

サンプルリクエスト ​

shell
curl -X DELETE 'https://YOUR_DATA_TABLES_DC/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/import' \
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

インポート用にアップロードされたファイルが削除されると、空のdataオブジェクトと共に200 OKが返されます。

json
{
  "data": {}
}
破棄するインポートが存在しない

次の例では、テーブルに対してインポートが開始されていないため、リクエストはIMPORT_STATE_ERRORコードを含む400 Bad Requestエラーを返します。

json
{
  "errors": [
    { "code": "IMPORT_STATE_ERROR", "title": "import not started" }
  ]
}
テーブルが見つからない

このリクエストは、データテーブルが存在しないかスコープ外であるため、次の例のように 404 Not Found エラーを返します。

json
{
  "errors": [
    { "code": "TABLE_NOT_FOUND" }
  ]
}

最終更新日: