製品アップデートステータスページWorkato Academy
English
日本語
トライアルを開始
Embedded API
リソース

Data tables ​

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

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

機能の提供状況

Data Table APIは現在、WorkatoのData tablesベータプログラムに参加しているワークスペースでのみアクセスできます。 詳細については、カスタマーサクセス担当者にお問い合わせください。

レート制限 ​

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

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

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

各データセンター（DC）には専用のベースURLがあります。 ワークスペースのリージョンに一致するベースURLを使用します。 このセクションのサンプルリクエストでは、USベース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
Trialhttps://data-tables.trial.workato.com

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

テーブル管理API ​

以下のエンドポイントを使用して、顧客ワークスペース内のdata tablesを管理および構造化します。

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

リージョン別ベースURL

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

クイックリファレンス ​

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

顧客ワークスペース内のdata tablesを一覧表示 ​

顧客のワークスペース内にあるすべてのdata tablesのリストを返します。

text
GET /api/v2/managed_users/:managed_user_id/data_tables

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

クエリパラメーター ​

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

サンプルリクエスト ​

shell
curl  -X GET 'https://www.workato.com/api/v2/managed_users/EA2300/data_tables'
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "data": [
        {
            "id": "cafd30b6-23e1-4a73-9fa6-68fc18356db4",
            "name": "drtdr",
            "schema": [],
            "folder_id": 25178157,
            "created_at": "2025-05-23T13:14:11.397-07:00",
            "updated_at": "2025-05-23T13:14:11.397-07:00"
        }
    ]
}

IDでData tablesを取得 ​

data tableのIDを使用して、顧客ワークスペース内のdata tableを取得します。

text
GET /api/v2/managed_users/:managed_user_id/data_tables/:data_table_id

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		取得するdata tableのID。 Data tablesの一覧表示エンドポイントを使用して、Data tables IDを取得できます。
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

サンプルリクエスト ​

shell
curl  -X GET 'https://www.workato.com/api/v2/managed_users/EA2300/data_tables/cafd30b6-23e1-4a73-9fa6-68fc18356db4'
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
{
    "data": {
        "id": "cafd30b6-23e1-4a73-9fa6-68fc18356db4",
        "name": "drtdr",
        "schema": [],
        "folder_id": 25178157,
        "created_at": "2025-05-23T13:14:11.397-07:00",
        "updated_at": "2025-05-23T13:14:11.397-07: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 - 制限を参照してください。

失敗したインポートの例

次の例では、テキスト値が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
      }
    }
  }
}

Data tablesの作成 ​

顧客ワークスペース内にdata tableを作成します。

text
POST /api/v2/managed_users/:managed_user_id/data_tables

URLパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

ペイロード ​

名前タイプ説明
namestring
必須		作成するData tablesの名前。
folder_idnumber
必須		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/v2/managed_users/EA2300/data_tables'
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
   -d '{
            "name": "Resume screening",
            "folder_id": 25178157,
            "schema": [
                {
                    "type": "string",
                    "name": "Applicant name",
                    "optional": false,
                    "multivalue": true
                },
                {
                    "type": "date",
                    "name": "Application date",
                    "optional": true
                },
                {
                    "type": "boolean",
                    "name": "Review status",
                    "optional": true
                },
                {
                    "type": "date_time",
                    "name": "Interview time",
                    "optional": true
                },
                {
                    "type": "file",
                    "name": "Resume",
                    "optional": true
                },
                {
                    "type": "integer",
                    "name": "Years of experience",
                    "optional": true
                },
                {
                    "type": "number",
                    "name": "Salary expectation",
                    "optional": true
                }
            ]
        }'

レスポンス ​

json
{
    "data": {
        "id": "dcb981cf-3e5e-4b79-ab78-1fe0115bc5e8",
        "name": "Resume screening",
        "schema": [
            {
                "type": "string",
                "name": "Applicant name",
                "optional": false,
                "field_id": "9b213e57-2ff9-4276-a65f-5afaa14789fd",
                "default_value": [],
                "metadata": {},
                "multivalue": true
            },
            {
                "type": "date",
                "name": "Application date",
                "optional": true,
                "field_id": "3e1c6061-ff84-47e9-80ac-145aff0f6206",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "boolean",
                "name": "Review status",
                "optional": true,
                "field_id": "e3106d74-bd0b-47a6-a936-8b7a03fd9fee",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "date_time",
                "name": "Interview time",
                "optional": true,
                "field_id": "0adb665a-8579-4cc2-a46d-8f43be7fbdbb",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "file",
                "name": "Resume",
                "optional": true,
                "field_id": "e300122c-dbd8-45f3-91fd-1bb060c92b95",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "integer",
                "name": "Years of experience",
                "optional": true,
                "field_id": "4763bde7-c46b-48d7-bc5f-cbb0e3132646",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "number",
                "name": "Salary expectation",
                "optional": true,
                "field_id": "0778952c-ce6e-4f7b-9bd1-c265a9e98702",
                "metadata": {},
                "multivalue": false
            }
        ],
        "folder_id": 25178157,
        "created_at": "2025-05-27T11:49:06.226-07:00",
        "updated_at": "2025-05-27T11:49:06.226-07:00"
    }
}

Data tablesの更新 ​

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

text
PUT /api/v2/managed_users/:managed_user_id/data_tables/:data_table_id

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		更新する予定のData tablesのID。 Data tablesの一覧表示エンドポイントを使用して、Data tables IDを取得できます。
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

ペイロード ​

名前タイプ説明
namestring
必須		data tableの更新後の名前。
folder_idnumber
optional		data tableの移動先フォルダのIDを指定します。
schemaarray
optional		テーブル構造を変更するには、ネストされた要素の配列を指定します。 列名、データ型、および列が必須かどうかを指定する必要があります。
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 PUT 'https://www.workato.com/api/v2/managed_users/EA2300/data_tables/dcb981cf-3e5e-4b79-ab78-1fe0115bc5e8'
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
   -d '{
            "name": "Resume screening",
            "folder_id": 25178157,
            "schema": [
                {
                    "type": "string",
                    "name": "Applicant name",
                    "optional": false,
                    "multivalue": true
                },
                {
                    "type": "date",
                    "name": "Potential start date",
                    "optional": true
                },
                {
                    "type": "boolean",
                    "name": "Remote worker",
                    "optional": true
                },
                {
                    "type": "date_time",
                    "name": "Interview time",
                    "optional": true
                },
                {
                    "type": "file",
                    "name": "Resume",
                    "optional": true
                },
                {
                    "type": "integer",
                    "name": "Miles from office",
                    "optional": true
                },
                {
                    "type": "number",
                    "name": "Interviews completed",
                    "optional": true
                }
            ]
        }'

レスポンス ​

json
{
    "data": {
        "id": "dcb981cf-3e5e-4b79-ab78-1fe0115bc5e8",
        "name": "Resume screening",
        "schema": [
            {
                "type": "string",
                "name": "Applicant name",
                "optional": false,
                "field_id": "c0eee384-9967-47da-b8b3-b5faa4654df8",
                "default_value": [],
                "metadata": {},
                "multivalue": true
            },
            {
                "type": "date",
                "name": "Potential start date",
                "optional": true,
                "field_id": "2c623992-ac87-4560-931e-0b3b58b3016f",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "boolean",
                "name": "Remote worker",
                "optional": true,
                "field_id": "ac4e7e53-a157-42b8-85f7-e4a2042b42c2",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "date_time",
                "name": "Interview time",
                "optional": true,
                "field_id": "749eaef4-a714-4c6a-b65e-641bf88dc11b",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "file",
                "name": "Resume",
                "optional": true,
                "field_id": "0e36fa59-1d80-475c-a83f-4f47562a641d",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "integer",
                "name": "Miles from office",
                "optional": true,
                "field_id": "e098f6ca-5165-4c54-9ff1-02d72fe91d13",
                "metadata": {},
                "multivalue": false
            },
            {
                "type": "number",
                "name": "Interviews completed",
                "optional": true,
                "field_id": "f9e5af87-57c9-4611-befb-4f43fface977",
                "metadata": {},
                "multivalue": false
            }
        ],
        "folder_id": 25178157,
        "created_at": "2025-05-27T11:49:06.226-07:00",
        "updated_at": "2025-05-27T11:49:06.226-07:00"
    }
}

Data tablesの削除 ​

顧客ワークスペース内のdata tableを削除します。

text
DELETE /api/v2/managed_users/:managed_user_id/data_tables/:data_table_id

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		削除するdata tableのID。 Data tablesの一覧表示エンドポイントを使用して、Data tables IDを取得できます。
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

サンプルリクエスト ​

shell
curl  -X DELETE 'https://www.workato.com/api/v2/managed_users/EA2300/data_tables/cafd30b6-23e1-4a73-9fa6-68fc18356db4'
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

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

Data tablesの切り詰め ​

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

text
POST /api/v2/managed_users/:managed_user_id/data_tables/:data_table_id/truncate

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		切り詰めるdata tableのID。 Data tablesの一覧表示エンドポイントを使用して、Data tables IDを取得できます。
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

サンプルリクエスト ​

shell
curl  -X POST 'https://www.workato.com/api/v2/managed_users/EA2300/data_tables/cafd30b6-23e1-4a73-9fa6-68fc18356db4/truncate'
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

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

レコード操作API ​

次のエンドポイントを使用して、顧客ワークスペース内のdata tableレコードを作成、削除、更新できます。 詳細については、OpenAPI Specificationを参照してください。

ベースURL: https://data-tables.workato.com

リージョン別ベースURL

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

クイックリファレンス ​

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

レコードのクエリ ​

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

text
POST /api/v1/managed_users/:managed_user_id/tables/:data_table_id/query

URLパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。
data_table_idstring
必須		クエリするdata tableの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句は次の形式を使用します:

text
{ <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>,
  "direction": "asc" | "desc",
  "case_sensitive": true | false
}

サンプルリクエスト ​

shell
curl  -X POST 'https://data-tables.workato.com/api/v1/managed_users/EA2300/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
}

レコードの作成 ​

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

text
POST /api/v1/managed_users/:managed_user_id/tables/:data_table_id/records

URLパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。
data_table_idstring
必須		レコードを作成する予定のData tablesのID。 Data tablesの一覧表示エンドポイントを使用して、Data tables IDを取得できます。

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X POST 'https://data-tables.workato.com/api/v1/managed_users/EA2300/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"
                }
            }
        ]
    }
}

レコードの更新 ​

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

text
PUT /api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/:record_id

URLパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。
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/managed_users/EA2300/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"
                }
            }
        ]
    }
}

レコードの削除 ​

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

text
DELETE /api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/:record_id

URLパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。
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/managed_users/EA2300/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/ab0189ca-fadf-4382-a48b-e157d966078f' \
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

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

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

text
POST /api/v1/managed_users/:managed_user_id/tables/:data_table_id/fields/:field_id/file
名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。
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/managed_users/EA2300/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"
  }
}

レコードからのファイルのダウンロード ​

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

text
GET /api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/:record_id/fields/:field_id/file

URLパラメータ ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。
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/managed_users/EA2300/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/ab0189ca-fadf-4382-a48b-e157d966078f/fields/f71f1f67-0de5-422c-be73-b27b12f442c4/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/managed_users/:managed_user_id/tables/:data_table_id/records/import/file/upload_linkファイルをアップロードするためのリンクを作成します。
POST/sharing/files署名付きリンクにファイルをアップロードします。
DELETE/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/fileアップロード済みファイルを削除します。
GET/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/fileアップロード済みファイルの詳細を返します。
POST/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/startアップロード済みファイルからレコードのインポートを開始します。
DELETE/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/importインポートを破棄またはキャンセルします。

インポートステータスを確認するには、IDでデータテーブルを取得エンドポイントを使用し、records_import_statusフィールドを読み取ります。

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

ベースURL: https://data-tables.workato.com

POST /api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/file/upload_link
名前タイプ説明
data_table_idstring
必須		レコードのインポート先となるデータテーブルのID。 Data tablesの一覧表示エンドポイントを使用して、Data tables IDを取得できます。
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。
名前タイプ説明
file_formathash
required		アップロードするファイルの形式。
file_format[format]string
必須		ファイル形式。 現在サポートされているのはcsvのみです。
file_format[has_header]boolean
必須		ファイルの最初の行に列ラベルがあるかどうか。
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://data-tables.workato.com/api/v1/managed_users/EA2300/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"
           }
         }'

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

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: https://file-storage.workato.com

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
}

アップロードされたファイルの削除 ​

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

ベースURL: https://data-tables.workato.com

DELETE /api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/file

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		アップロードされたファイルを削除する対象のデータテーブルのID。
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

サンプルリクエスト ​

shell
curl -X DELETE 'https://data-tables.workato.com/api/v1/managed_users/EA2300/tables/58408ccc-e209-491b-9873-4549b5fa48df/records/import/file' \
     -H 'Authorization: Bearer <api_token>'

レスポンス ​

空の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" }
  ]
}

アップロードされたファイルの記述 ​

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

ベースURL: https://data-tables.workato.com

GET /api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/file

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		アップロードされたファイルを記述する対象のデータテーブルのID。
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

サンプルリクエスト ​

shell
curl -X GET 'https://data-tables.workato.com/api/v1/managed_users/EA2300/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" }
  ]
}

インポートの開始 ​

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

前提条件

インポートの開始エンドポイントには、次の前提条件があります:

  • ファイルアップロードエンドポイントを使用してファイルをアップロードします。
  • すべてのテーブル列がターゲット宛先に存在することを確認します。 インポートを開始する前に、不足している列をデータテーブルの更新エンドポイントで追加します。

ベースURL: https://data-tables.workato.com

POST /api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/start

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		レコードのインポート先となるデータテーブルのID。
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

ペイロード ​

名前タイプ説明
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です。 詳細については、インポートモードを参照してください。
インポートモード ​

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

モード動作
assert_table_emptyインポートは、テーブルが空の場合にのみ続行されます。 それ以外の場合は、エラーを返します。
truncate_tableインポート前に、既存のすべてのレコードが削除されます。 データテーブルの切り捨て権限が必要です。
appendレコードはテーブル内の既存レコードに追加されます。

サンプルリクエスト ​

shell
curl -X POST 'https://data-tables.workato.com/api/v1/managed_users/EA2300/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を返します。 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" }
  ]
}

インポートの却下 ​

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

ベースURL: https://data-tables.workato.com

DELETE /api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import

URLパラメータ ​

名前タイプ説明
data_table_idstring
必須		インポートを却下またはキャンセルする対象のデータテーブルのID。
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 外部IDにはプレフィックスEが必要で、URLエンコードされている必要があります。 例: EA2300。

サンプルリクエスト ​

shell
curl -X DELETE 'https://data-tables.workato.com/api/v1/managed_users/EA2300/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" }
  ]
}

インポートステータスを確認するには、IDでデータテーブルを取得エンドポイントを使用し、records_import_statusフィールドを読み取ります。

最終更新日: