ルックアップテーブル

次のエンドポイントを使用して、ルックアップテーブルをプログラムで管理します。

レート制限

ルックアップテーブルリソースには、次のレート制限があります:

タイプ	リソース	制限
POST	ルックアップテーブルを一括削除: /api/lookup_tables/batch_delete	1秒あたり1リクエスト
すべて	その他すべてのルックアップテーブルエンドポイント	1分あたり60リクエスト

クイックリファレンス

タイプ	リソース	説明
GET	/api/lookup_tables	テーブルを一覧表示します。
GET	/api/lookup_tables/:lookup_table_id/rows	行を一覧表示します。
GET	/api/lookup_tables/:lookup_table_id/lookup	行を検索します。
GET	/api/lookup_tables/:lookup_table_id/rows/:row_id	行を取得します。
POST	/api/lookup_tables/:lookup_table_id/rows	行を追加します。
POST	/api/lookup_tables	新しいルックアップテーブルを作成します。
POST	/api/lookup_tables/batch_delete	ルックアップテーブルを一括削除します。
PUT	/api/lookup_tables/:lookup_table_id/rows/:row_id	行を更新します。
DELETE	/api/lookup_tables/:lookup_table_id/rows/:row_id	行を削除します。

ルックアップテーブルの一覧表示

顧客に属するルックアップテーブルのリストを返します。 Workatoは、レスポンスにルックアップテーブルが属するプロジェクトのproject_idを含めます。

GET /api/lookup_tables

パラメーター

名前	タイプ	説明
page	integer	ページ番号。デフォルトは1です。
per_page	integer	ページサイズ。デフォルトは100（最大は100）です。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/lookup_tables' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

レスポンス

json

[
  {
    "id": 1315,
    "name": "lookup_table4",
    "schema":
    "[{\"control_type\":\"text\",\"label\":\"code\",\"name\":\"col1\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"name\",\"name\":\"col2\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"col3\",\"name\":\"col3\",\"type\":\"string\",\"sticky\":false},{\"control_type\":\"text\",\"label\":\"col4\",\"name\":\"col4\",\"type\":\"string\",\"sticky\":false},{\"control_type\":\"text\",\"label\":\"col5\",\"name\":\"col5\",\"type\":\"string\",\"sticky\":false}]",
    "created_at": "2022-05-20T11:54:26.934-07:00",
    "updated_at": "2022-05-20T11:54:26.934-07:00",
    "project_id": "523144"
  }
]

行の一覧表示

ルックアップテーブルから行のリストを返します。フィルタリングとページネーションをサポートしています。

GET /api/lookup_tables/:lookup_table_id/rows

URLパラメーター

名前	タイプ	説明
lookup_table_id	integer required	ルックアップテーブルID

クエリパラメーター

名前	タイプ	説明
page	integer	ページ番号。デフォルトは1です。
per_page	integer	ページサイズ。デフォルトは500です（最大は1000）。
by`[<col name>]`	string	フィルター条件。列名は次のように指定する必要があります: `by[<col name>]`。複数の列で照合するには、複数のパラメーターを指定します。詳細については、サンプルリクエストを参照してください。指定しない場合、すべての行が返されます。

サンプルリクエスト

リクエスト1: 行の一覧表示

shell

curl  -X GET https://www.workato.com/api/lookup_tables/1296/rows \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'

リクエスト2: 行のフィルタリングと一覧表示

shell

curl  -X GET https://www.workato.com/api/lookup_tables/1296/rows?by[code]=US \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'

レスポンス

レスポンス1: 行の一覧表示

json

[
      {
        "id": 941,
        "data": {
          "code": "IND",
          "name": "India",
          "col3": null,
          "col4": null,
          "col5": null
        },
        "created_at": "2022-06-15T11:50:32.986-07:00",
        "updated_at": "2022-06-15T11:50:40.986-07:00"
      },
      {
        "id": 942,
        "data": {
          "code": "US",
          "name": "United States",
          "col3": null,
          "col4": null,
          "col5": null
        },
        "created_at": "2022-05-20T11:50:32.986-07:00",
        "updated_at": "2022-05-20T11:50:40.986-07:00"
      }
]

レスポンス2: 行のフィルタリングと一覧表示

json

[
      {
        "id": 942,
        "data": {
          "code": "US",
          "name": "United States",
          "col3": null,
          "col4": null,
          "col5": null
        },
        "created_at": "2022-05-20T11:50:32.986-07:00",
        "updated_at": "2022-05-20T11:50:40.986-07:00"
      }
]

行の検索

指定された条件に一致するルックアップテーブル内の最初の行を検索します。検索に失敗した場合は404を返します。

GET /api/lookup_tables/:lookup_table_id/lookup

URLパラメーター

名前	タイプ	説明
lookup_table_id	integer required	ルックアップテーブルID

クエリパラメーター

名前	タイプ	説明
by`[<col name>]`	string 必須	検索条件。列名は次のように指定する必要があります: `by[<col name>]`。複数の列で照合するには、複数のパラメーターを指定します。詳細については、サンプルリクエストを参照してください。

サンプルリクエスト

shell

curl  -X GET https://www.workato.com/api/lookup_tables/1296/rows/942?by[code]=US \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'

レスポンス

json

{
  "id": 942,
  "data": {
    "code": "US",
    "name": "United States",
    "col3": null,
    "col4": null,
    "col5": null
  },
  "created_at": "2022-05-20T11:50:32.986-07:00",
  "updated_at": "2022-05-20T11:50:40.986-07:00"
}

行の取得

ルックアップテーブルから行を取得します。

GET /api/lookup_tables/:lookup_table_id/rows/:row_id

URLパラメーター

名前	タイプ	説明
lookup_table_id	integer required	ルックアップテーブルID
row_id	integer required	行ID

サンプルリクエスト

shell

curl  -X GET https://www.workato.com/api/lookup_tables/1296/rows/942 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'

レスポンス

json

{
  "id": 942,
  "data": {
    "code": "US",
    "name": "United States",
    "col3": null,
    "col4": null,
    "col5": null
  },
  "created_at": "2022-05-20T11:50:32.986-07:00",
  "updated_at": "2022-05-20T11:50:40.986-07:00"
}

行の追加

ルックアップテーブルに行を追加します。

POST /api/lookup_tables/:lookup_table_id/rows

URLパラメーター

名前	タイプ	説明
lookup_table_id	integer required	ルックアップテーブルID

ペイロード

名前	タイプ	説明
data	ハッシュ必須	ハッシュには新しい行のデータが含まれます。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/lookup_tables/1296/rows \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ "data": { "name": "United States", "code": "USA" }}'

レスポンス

json

{
  "id": 942,
  "data": {
    "code": "USA",
    "name": "United States",
    "col3": null,
    "col4": null,
    "col5": null
  },
  "created_at": "2022-05-20T11:50:32.986-07:00",
  "updated_at": "2022-05-20T11:50:32.986-07:00"
}

新しいルックアップテーブルの作成

新しいルックアップテーブルを作成します。要件に応じて、ルックアップテーブルをワークスペース全体で一般アクセス可能にするか、範囲を特定のプロジェクトに制限するかを選択できます。

POST /api/lookup_tables

ペイロード

名前	タイプ	説明
name	string 必須	新しいルックアップテーブルの名前を指定します。
project_id	integer optional	`project_id`を指定して、ルックアップテーブルの範囲を特定のプロジェクトに限定します。 `project_id`を指定しない場合、ルックアップテーブルの範囲はグローバルになります。ワークスペース内のプロジェクトのリストを取得するには、プロジェクトの一覧表示APIを使用します。
schema	hash required	schemaを指定し、テーブル内の各列の名前を指定して、ルックアップテーブルの構造を決定します。例: `[{ "label": "Name" }]`。ルックアップテーブルは最大10列をサポートしています。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/lookup_tables \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "lookup_table": {
            "name": "Contacts",
            "project_id": 4321,
            "schema": [{ "label": "ID" }, { "label": "Name" }, {"label": "CSM"}, {"label": "Email"}, {"label": "Phone number"}, {"label": "Priority"}, {"label": "Tier"}, {"label": "Notes"}, {"label": "Created at"}, {"label": "Updated at"}]
            }
          }'

レスポンス

json

{
    "id": 2372,
    "name": "Contacts",
    "schema": "[{\"control_type\":\"text\",\"label\":\"ID\",\"name\":\"col1\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"Name\",\"name\":\"col2\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"CSM\",\"name\":\"col3\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"Email\",\"name\":\"col4\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"Phone number\",\"name\":\"col5\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"Priority\",\"name\":\"col6\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"Tier\",\"name\":\"col7\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"Notes\",\"name\":\"col8\",\"type\":\"string\",\"sticky\":true},{\"control_type\":\"text\",\"label\":\"Created at\",\"name\":\"col9\",\"type\":\"string\",\"sticky\":false},{\"control_type\":\"text\",\"label\":\"Updated at\",\"name\":\"col10\",\"type\":\"string\",\"sticky\":false}]",
    "project_id": 4321,
    "created_at": "2023-09-11T11:31:35.335-07:00",
    "updated_at": "2023-09-11T11:31:35.335-07:00"
}

ルックアップテーブルの一括削除

このエンドポイントを使用して、ルックアップテーブルを一括削除します。

POST /api/lookup_tables/batch_delete

ペイロード

名前	タイプ	説明
ids	hash required	削除するルックアップテーブルのIDを含めます。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/lookup_tables/batch_delete \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ "ids": [1234, 1235, 1236] }'

レスポンス

json

{
    "data": {"deleted": [1234, 1235, 1236] },
    "errors": []
}

行の更新

ルックアップテーブル内の行を更新します。

PUT /api/lookup_tables/:lookup_table_id/rows/:row_id

URLパラメーター

名前	タイプ	説明
lookup_table_id	integer required	ルックアップテーブルID
row_id	integer required	行ID

ペイロード

名前	タイプ	説明
data	ハッシュ必須	更新された行のデータを含むハッシュ。指定された列のみが更新されます。

サンプルリクエスト

shell

curl  -X PUT https://www.workato.com/api/lookup_tables/1296/rows/942 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ "data": { "code": "US" }}'

レスポンス

json

{
  "id": 942,
  "data": {
    "code": "US",
    "name": "United States",
    "col3": null,
    "col4": null,
    "col5": null
  },
  "created_at": "2022-05-20T11:50:32.986-07:00",
  "updated_at": "2022-05-20T11:50:40.986-07:00"
}

行の削除

ルックアップテーブルから行を削除します

DELETE /api/lookup_tables/:lookup_table_id/rows/:row_id

URLパラメーター

名前	タイプ	説明
lookup_table_id	integer required	ルックアップテーブルID
row_id	integer required	行ID

サンプルリクエスト

shell

curl  -X DELETE https://www.workato.com/api/lookup_tables/1296/rows/942 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json'

レスポンス

json

{
  "success": true
}

Last updated:

ルックアップ テーブル ​

レート制限 ​

クイックリファレンス ​

ルックアップ テーブルの一覧表示 ​

パラメーター ​

サンプルリクエスト ​

レスポンス ​

行の一覧表示 ​

URLパラメーター ​

クエリパラメーター ​

サンプルリクエスト ​

リクエスト1: 行の一覧表示 ​

リクエスト2: 行のフィルタリングと一覧表示 ​

レスポンス ​

レスポンス1: 行の一覧表示 ​

レスポンス2: 行のフィルタリングと一覧表示 ​

行の検索 ​

URLパラメーター ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

行の取得 ​

URLパラメーター ​

サンプルリクエスト ​

レスポンス ​

行の追加 ​

URLパラメーター ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

新しいルックアップ テーブルの作成 ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

ルックアップ テーブルの一括削除 ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

行の更新 ​

URLパラメーター ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

行の削除 ​

URLパラメーター ​

サンプルリクエスト ​

レスポンス ​

ルックアップテーブル

レート制限

クイックリファレンス

ルックアップテーブルの一覧表示

パラメーター

サンプルリクエスト

レスポンス

行の一覧表示

URLパラメーター

クエリパラメーター

サンプルリクエスト

リクエスト1: 行の一覧表示

リクエスト2: 行のフィルタリングと一覧表示

レスポンス

レスポンス1: 行の一覧表示

レスポンス2: 行のフィルタリングと一覧表示

行の検索

URLパラメーター

クエリパラメーター

サンプルリクエスト

レスポンス

行の取得

URLパラメーター

サンプルリクエスト

レスポンス

行の追加

URLパラメーター

ペイロード

サンプルリクエスト

レスポンス

新しいルックアップテーブルの作成

ペイロード

サンプルリクエスト

レスポンス

ルックアップテーブルの一括削除

ペイロード

サンプルリクエスト

レスポンス

行の更新

URLパラメーター

ペイロード

サンプルリクエスト

レスポンス

行の削除

URLパラメーター

サンプルリクエスト

レスポンス