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

ルックアップ テーブル ​

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

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

レート制限 ​

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

タイプリソース制限
GET行を一覧表示:
/api/managed_users/:managed_user_id
/lookup_tables/:lookup_table_id/rows		1分あたり1,000リクエスト
すべてその他すべてのルックアップ テーブルエンドポイント1分あたり60リクエスト

クイックリファレンス ​

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

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

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

GET /api/managed_users/:managed_user_id/lookup_tables

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。

クエリパラメーター ​

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

サンプルリクエスト ​

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

レスポンス ​

json
{
  "result": [
    {
      "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"
    }
  ]
}

行の検索 ​

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

GET /api/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/lookup

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。
lookup_table_idinteger
required		ルックアップ テーブルID

クエリパラメーター ​

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

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/managed_users/157/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/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。
lookup_table_idinteger
required		ルックアップ テーブルID

クエリパラメーター ​

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

サンプルリクエスト ​

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

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

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

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

レスポンス ​

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

json
{
       "result": [
            {
              "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
{
       "result": [
            {
              "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/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows/:row_id

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。
lookup_table_idinteger
required		ルックアップ テーブルID
row_idinteger
required		行ID

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/managed_users/157/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/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。
lookup_table_idinteger
required		ルックアップ テーブルID

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/managed_users/157/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/managed_users/:managed_user_id/lookup_tables

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
External IDにはE（例: EA2300）のプレフィックスを付け、生成されたIDをURLエンコードする必要があります。

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/managed_users/121/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/managed_users/:managed_user_id/lookup_tables/batch_delete

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
External IDにはE（例: EA2300）のプレフィックスを付け、生成されたIDをURLエンコードする必要があります。

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/managed_users/121/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/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows/:row_id

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。
lookup_table_idinteger
required		ルックアップ テーブルID
row_idinteger
required		行ID

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X PUT https://www.workato.com/api/managed_users/157/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/managed_users/:managed_user_id/lookup_tables/:lookup_table_id/rows/:row_id

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。
lookup_table_idinteger
required		ルックアップ テーブルID
row_idinteger
required		行ID

サンプルリクエスト ​

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

レスポンス ​

json
{
  "success": true
}

Last updated: