Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Developer API
リソース

Data tables ​

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

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

レート制限 ​

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

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

テーブル管理API ​

次のエンドポイントを使用して、Data tablesを管理および構造化できます:

ベースURL: https://www.workato.com

クイックリファレンス ​

タイプリソース説明
GET/api/data_tablesすべてのData tablesを一覧表示します。
GET/api/data_tables/:data_table_idIDでData tablesを取得します。
POST/api/data_tablesData tablesを作成します。
PUT/api/data_tables/:data_table_idData tablesを更新します。
DELETE/api/data_tables/:data_table_idData tablesを削除します。
POST/api/data_tables/:data_table_id/truncateData tablesを切り詰めます。

Data tablesの一覧表示 ​

ワークスペース内のすべてのData tablesの一覧を返します。

GET /api/data_tables

URLパラメーター ​

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

サンプルリクエスト ​

shell
curl  -X GET 'https://www.workato.com/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でData tablesを取得 ​

指定したIDに関連付けられているData tablesを返します。

GET /api/data_tables/:data_table_id

URLパラメータ ​

名前タイプ説明
data_table_idinteger
required		特定のData tablesのIDを指定します。

サンプルリクエスト ​

shell
curl  -X GET 'https://www.workato.com/api/data_tables/db4b8544-8de8-4c6d-83bd-e487f6616ccc'
      -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"
    }
}

Data tablesの作成 ​

指定したフォルダにData tablesを作成します。

POST /api/data_tables

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X POST 'https://www.workato.com/api/data_tables' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "name": "Expense reports 4",
            "folder_id": 75509,
            "schema": [
                {
                    "type": "string",
                    "name": "Expense type",
                    "optional": false,
                    "multivalue": true
                },
                {
                    "type": "date",
                    "name": "Date",
                    "optional": true
                },
                {
                    "type": "boolean",
                    "name": "Status",
                    "optional": true
                },
                {
                    "type": "date_time",
                    "name": "Check-in",
                    "optional": true
                },
                {
                    "type": "file",
                    "name": "Reciept",
                    "optional": true
                },
                {
                    "type": "integer",
                    "name": "Days at hotel",
                    "optional": true
                },
                {
                    "type": "number",
                    "name": "Cost",
                    "optional": true
                },
                {
                    "type": "relation",
                    "name": "Budget",
                    "optional": true,
                    "relation": {
                        "table_id": "2507a39a-6847-4857-88ed-c3b9c8302e02",
                        "field_id": "900454f4-5b3d-4670-bc3c-d640915156f2"
                    }
                }
            ]
        }

レスポンス ​

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",
                "default_value": [],
                "metadata": {},
                "multivalue": true
            },
            {
                "type": "date",
                "name": "Date",
                "optional": true,
                "field_id": "c6e0ee37-827c-4d41-9e1a-7cac79e07678",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "boolean",
                "name": "Status",
                "optional": true,
                "field_id": "e170b117-d744-44ba-9f65-0a616646056a",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "date_time",
                "name": "Check-in",
                "optional": true,
                "field_id": "f289a693-a97f-41bb-b0e0-96dc532ccd0c",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "file",
                "name": "Reciept",
                "optional": true,
                "field_id": "b92fa6c1-f6ed-4ff2-98dd-a774cf560ec0",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "integer",
                "name": "Days at hotel",
                "optional": true,
                "field_id": "bf3ec7b5-0b41-453f-810a-5d53b1582b65",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "number",
                "name": "Cost",
                "optional": true,
                "field_id": "566307b9-bfda-4f77-af55-3c258359f656",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "relation",
                "name": "Budget",
                "optional": true,
                "field_id": "d7f4d5dd-2cb6-45d5-95c1-8d14339a50ba",
                "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-21T14:56:49.173-07:00"
    }
}

Data tablesの更新 ​

指定したData tablesを更新します。

PUT /api/data_tables/:data_table_id

URLパラメータ ​

名前タイプ説明
data_table_idstring更新する予定のData tablesのID。 Data tablesの一覧表示エンドポイントを使用して、Data tables IDを取得できます。

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X POST 'https://www.workato.com/api/data_tables' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "name": "Expense reports updated",
            "folder_id": 75509,
            "schema": [
                {
                    "type": "string",
                    "name": "Expense type",
                    "optional": false,
                    "multivalue": true
                },
                {
                    "type": "date",
                    "name": "Date",
                    "optional": true
                },
                {
                    "type": "boolean",
                    "name": "Status",
                    "optional": true
                },
                {
                    "type": "date_time",
                    "name": "Check-in",
                    "optional": true
                },
                {
                    "type": "file",
                    "name": "Reciept",
                    "optional": true
                },
                {
                    "type": "integer",
                    "name": "Length of stay in days",
                    "optional": true
                },
                {
                    "type": "number",
                    "name": "Cost",
                    "optional": true
                },
                {
                    "type": "relation",
                    "name": "Budget",
                    "optional": true,
                    "relation": {
                        "table_id": "2507a39a-6847-4857-88ed-c3b9c8302e02",
                        "field_id": "900454f4-5b3d-4670-bc3c-d640915156f2"
                    }
                }
            ]
        }

レスポンス ​

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"
    }
}

Data tablesの削除 ​

指定したData tablesを削除します。

DELETE /api/data_tables/:data_table_id

URLパラメータ ​

名前タイプ説明
data_table_idinteger
required		Data tables ID。

サンプルリクエスト ​

shell
curl -X DELETE 'https://www.workato.com/api/data_tables/e9498300-1ea3-4bf0-bdea-ffe58c101bcf'
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

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

Data tablesの切り詰め ​

指定したData tablesを切り詰めます。 Data tablesを切り詰めると、Data tablesからすべてのデータが削除されますが、テーブル構造には影響しません。

POST /api/data_tables/:data_table_id/truncate

URLパラメータ ​

名前タイプ説明
data_table_idinteger
required		Data tables ID。

サンプルリクエスト ​

shell
curl  -X POST 'https://www.workato.com/api/data_tables/58408ccc-e209-491b-9873-4549b5fa48df/truncate'
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

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

レコード操作API ​

次のエンドポイントを使用して、Data tablesレコードを作成、削除、および更新できます。 詳細については、OpenAPI Specificationを参照してください。

各データセンター（DC）には専用のベースURLがあります。 ワークスペースのリージョンと一致するベース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
Trialhttps://data-tables.trial.workato.com

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

クイックリファレンス ​

タイプリソース説明
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） ​

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

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

URLパラメータ ​

名前タイプ説明
data_table_idstring更新する予定のData tablesのID。 Data tablesの一覧表示エンドポイントを使用して、Data tables IDを取得できます。

ペイロード ​

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

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フィールドのhash構造 ​

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

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

サンプルリクエスト ​

shell
curl  -X POST 'https://data-tables.workato.com/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/query' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "select": ["Name","Address"],
            "where":
                {
                    "Age": { "$gt": 30 },
                    "Country": "USA",
                },
            "order": "$created_at",
            "limit": 10,
            "timezone_offset_secs": 0
        }'

レスポンス ​

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） ​

指定したData tablesにレコードを作成します。

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

URLパラメータ ​

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

ペイロード ​

リクエストペイロードの構造は、各フィールドのキーと値のペアです。 フィールドはUUID（ドルエスケープ）または名前で指定できます。 スキーマに一覧表示されていないフィールドはデフォルト値に置き換えられます。 スキーマに含まれていない余分なフィールドは無視されます。

サンプルリクエスト ​

shell
curl  -X POST 'https://data-tables.workato.com/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/records' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "document":
            {
                "name": "Josh",
                "multivalue": [1,2,3],
                "$28c00d59-7dbe-4134-85be-937513500500": 13,
                "date": "2022-02-01",
                "relation":
                    {
                        "record_id": "7a13304c-14cf-4e98-be31-331ccdb2b253"
                    },
                "file":
                    {
                        "filename": "birth_certificate.txt",
                        "upload_id": "2b90f1d2-53d5-45f5-9366-d37ce4976717"
                    }
            }
        }'

レスポンス ​

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） ​

指定したData tables内のレコードを更新します。

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

URLパラメータ ​

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

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X PUT 'https://data-tables.workato.com/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/ab0189ca-fadf-4382-a48b-e157d966078f' \
	  -H 'Authorization: Bearer <api_token>' \
	  -H 'Content-Type: application/json' \
	  -d '{
            "document":
            {
                "name": "Josh",
                "multivalue": [1,2,3],
                "$28c00d59-7dbe-4134-85be-937513500500": 13,
                "date": "2022-02-01",
                "relation":
                    {
                        "record_id": "7a13304c-14cf-4e98-be31-331ccdb2b253"
                    },
                "file":
                    {
                        "filename": "birth_certificate.txt",
                        "upload_id": "2b90f1d2-53d5-45f5-9366-d37ce4976717"
                    }
            }
        }'

レスポンス ​

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） ​

指定したData tables内のレコードを削除します。

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

URLパラメータ ​

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

サンプルリクエスト ​

shell
curl -X DELETE 'https://data-tables.workato.com/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/ab0189ca-fadf-4382-a48b-e157d966078f'
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

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

ファイル型列にファイルをアップロードするためのリンクを生成します。 レコードを作成または更新するときは、結果のupload_idを使用します。

POST /api/v1/tables/:data_table_id/fields/:field_id/file
名前タイプ説明
data_table_idstringレコードが存在するData tablesのID。 Data tablesの一覧表示エンドポイントを使用して、Data tables IDを取得できます。
field_idstringアップロードするファイルのファイル列のID。
shell
curl  -X POST 'https://data-tables.workato.com/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/fields/f71f1f67-0de5-422c-be73-b27b12f442c4/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 /api/v1/tables/:data_table_id/records/:record_id/fields/:field_id/file

URLパラメータ ​

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

サンプルリクエスト ​

shell
curl -X GET 'https://data-tables.workato.com/api/v1/tables/58408ccc-e209-491b-9873-4549b5fa48df/fields/f71f1f67-0de5-422c-be73-b27b12f442c4/file'
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

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

Last updated: