Data tables

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

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

機能の提供状況

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

レート制限

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

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

テーブル管理API

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

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

クイックリファレンス

タイプリソース説明
GET/api/v2/managed_users/:managed_user_id/data_tablesすべてのData tablesを一覧表示します。
GET/api/v2/managed_users/:managed_user_id/data_tables
/:data_table_id
IDで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_id
Data tablesを更新します。
DELETE/api/v2/managed_users/:managed_user_id/data_tables
/:data_table_id
Data tablesを削除します。
POST/api/v2/managed_users/:managed_user_id/data_tables
/:data_table_id/truncate
Data tablesを切り詰めます。

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

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

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

URLパラメーター

名前タイプ説明
managed_user_idstring
必須
Embedded顧客のアカウントIDまたはExternal ID。 External 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/5759164/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。 External IDにはプレフィックス'E'を付け、URLエンコードする必要があります。 例: 'EA2300'。

サンプルリクエスト

shell
curl  -X GET 'https://www.workato.com/api/v2/managed_users/5759164/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"
    }
}

Data tablesの作成

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

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

URLパラメータ

名前タイプ説明
managed_user_idstring
必須
Embedded顧客のアカウントIDまたはExternal ID。 External 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
列が必須か任意かを示します。 truefalse1、または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/5759164/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。 External 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
列が必須か任意かを示します。 truefalse1、または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/5759164/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。 External IDにはプレフィックス'E'を付け、URLエンコードする必要があります。 例: 'EA2300'。

サンプルリクエスト

shell
curl  -X DELETE 'https://www.workato.com/api/v2/managed_users/5759164/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。 External IDにはプレフィックス'E'を付け、URLエンコードする必要があります。 例: 'EA2300'。

サンプルリクエスト

shell
curl  -X POST 'https://www.workato.com/api/v2/managed_users/5759164/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

クイックリファレンス

タイプリソース説明
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。 External 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>,
  "order": "asc" | "desc",
  "case_sensitive": true | false
}

サンプルリクエスト

shell
curl  -X POST 'https://data-tables.workato.com/api/v1/managed_users/5759164/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。 External 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/5759164/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。 External 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/5759164/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。 External 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/5759164/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。 External 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/5759164/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。 External 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/5759164/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ステータスコードを返します。

Last updated: