Workato APIリソース

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

Agent Studio

タイプリソース説明
GET/api/agentic/geniesGenieのリストを返します。
POST/api/agentic/genies新しいGenieを作成します。
PUT/api/agentic/genies/:id既存のGenieを更新します。
GET/api/agentic/genies/:id指定したIDに関連付けられているGenieを返します。
DELETE/api/agentic/genies/:idGenieを削除します。
POST/api/agentic/genies/:id/start指定したIDに関連付けられているGenieを開始します。
POST/api/agentic/genies/:id/stop指定したIDに関連付けられているGenieを停止します。
POST/api/agentic/genies/:id/assign_skills指定したIDに関連付けられているGenieにスキルを割り当てます。
POST/api/agentic/genies/:id/remove_skills指定したIDに関連付けられているGenieからスキルを削除します。
POST/api/agentic/genies/:id/assign_knowledge_bases指定したIDに関連付けられているGenieにナレッジベースを割り当てます。
POST/api/agentic/genies/:id/remove_knowledge_bases指定したIDに関連付けられているGenieからナレッジベースを削除します。
POST/api/agentic/genies/:id/assign_user_groups指定したIDに関連付けられているGenieにユーザーグループアクセスを割り当てます。
POST/api/agentic/genies/:id/remove_user_groups指定したIDに関連付けられているGenieからユーザーグループアクセスを削除します。
GET/api/agentic/genies/:genie_id/guardrails指定したIDに関連付けられているGenieのガードレールとそのポリシーを返します。
PUT/api/agentic/genies/:genie_id/guardrails/policies/:policy_type指定したIDに関連付けられているGenieで、単一のガードレールポリシーを作成または更新します。
GET/api/agentic/genies/guardrails/policies/pii_entitiespii_detectionポリシーで使用できるPIIエンティティタイプ文字列のリストを返します。
GET/api/agentic/knowledge_basesナレッジベースのリストを返します。
POST/api/agentic/knowledge_bases新しいナレッジベースを作成します。
GET/api/agentic/knowledge_bases/:id指定したIDに関連付けられているナレッジベースを返します。
PUT/api/agentic/knowledge_bases/:id既存のナレッジベースを更新します。
DELETE/api/agentic/knowledge_bases/:idナレッジベースを削除します。
GET/api/agentic/knowledge_bases/:id/data_sources指定したナレッジベースIDに関連付けられているデータソースを返します。
GET/api/agentic/knowledge_bases/:id/recipes指定したナレッジベースIDに関連付けられているレシピを返します。
GET/api/agentic/skillsスキルのリストを返します。
POST/api/agentic/skills新しいスキルを作成します。
GET/api/agentic/skills/:id指定したIDに関連付けられているスキルを返します。

APIクライアント

タイプリソース説明
GET/api/developer_api_clientsDeveloper APIクライアントの一覧を表示します。
POST/api/developer_api_clientsDeveloper APIクライアントを作成します。
GET/api/developer_api_clients/:idID別のDeveloper APIクライアントを取得します。
PUT/api/developer_api_clients/:idDeveloper APIクライアントを更新します。
DELETE/api/developer_api_clients/:idDeveloper APIクライアントを削除します。
POST/api/developer_api_clients/:id/regenerateDeveloper APIクライアントトークンを再生成します。
GET/api/developer_api_client_rolesDeveloper APIクライアントロールの一覧を表示します。

API platform

タイプリソース説明
GET/api/api_collectionsAPIコレクションを一覧表示します。
POST/api/api_collectionsAPIコレクションを作成します。
GET/api/api_endpointsコレクション内のAPIエンドポイントを一覧表示します。
PUT/api/api_endpoints/:id/enableコレクション内のAPIエンドポイントを有効化します。
PUT/api/api_endpoints/:id/disableコレクション内のAPIエンドポイントを無効化します。
GET/api/api_clientsAPIクライアントを一覧表示します。 将来の廃止に備えて、APIクライアントの一覧表示(v2)エンドポイントへ移行することをお勧めします。
GET/api/v2/api_clientsすべてのAPIクライアントを一覧表示します。 Workatoは、APIクライアントに関連付けられたプロジェクトのproject_idをレスポンスに含めます。
POST/api/api_clientsAPIクライアントを作成します。 将来の廃止に備えて、APIクライアントの作成(v2)エンドポイントへ移行することをお勧めします。
POST/api/v2/api_clients指定したプロジェクト内に新しいAPIクライアントを作成します。
GET/api/v2/api_clients/:api_client_idIDでAPIクライアントの詳細を取得します。
PUT/api/v2/api_clients/:api_client_id指定したプロジェクト内の既存のAPIクライアントを更新します。
DELETE/api/v2/api_clients/:api_client_id既存のAPIクライアントを削除します。
GET/api/api_access_profilesAPIクライアントに属するアクセスプロファイルを一覧表示します。 将来の廃止に備えて、APIキーの一覧表示エンドポイントへ移行することをお勧めします。
GET/api/v2/api_clients/:api_client_id/api_keysAPIクライアントのAPI keyを一覧表示します。
POST/api/api_access_profilesAPIクライアントに属するアクセスプロファイルを作成します。 将来の廃止に備えて、APIキーの作成エンドポイントへ移行することをお勧めします。
POST/api/v2/api_clients/:api_client_id/api_keysAPIクライアントのAPI keyを作成します。
PUT/api/api_access_profilesAPIクライアントに属するアクセスプロファイルを更新します。 将来の廃止に備えて、APIキーの更新エンドポイントへ移行することをお勧めします。
PUT/api/v2/api_clients/:api_client_id/
api_keys/:api_key_id
APIクライアントのAPI keyを更新します。
PUT/api_access_profilesAPIクライアントに属するアクセスプロファイルを有効化します。 将来の廃止に備えて、APIキーの有効化エンドポイントへ移行することをお勧めします。
PUT/api/v2/api_clients/:api_client_id/
api_keys/:api_key_id/enable
APIクライアントのAPI keyを有効化します。
PUT/api_access_profilesAPIクライアントに属するアクセスプロファイルを無効化します。 将来の廃止に備えて、APIキーの無効化エンドポイントへ移行することをお勧めします。
PUT/api/v2/api_clients/:api_client_id/
api_keys/:api_key_id/disable
APIクライアントのAPI keyを無効化します。
PUT/api/api_access_profiles/:id/refresh_secretアクセスプロファイルキーまたはシークレットを更新します。 将来の廃止に備えて、APIキーシークレットの更新エンドポイントへ移行することをお勧めします。
PUT/api/v2/api_clients/:api_client_id/
api_keys/:api_key_id/refresh_secret
API keyの認証トークンまたはOAuth 2.0クライアントシークレットを更新します。
DELETE/api/v2/api_clients/:api_client_id/
api_keys/:api_key_id
既存のAPI keyを削除します。
GET/api/v2/api_portalsワークスペース内のAPIクライアントに関連付けられているすべてのAPIポータルを一覧表示します。

コラボレーターグループ

タイプリソース説明
GET/api/user_groupsコラボレーターグループを一覧表示します。
GET/api/user_groups/:idコラボレーターグループの詳細を取得します。
POST/api/user_groupsコラボレーターグループを作成します。
PUT/api/user_groups/:idコラボレーターグループを更新します。
DELETE/api/user_groups/:idコラボレーターグループを削除します。
GET/api/user_groups/:id/membersコラボレーターグループのメンバーを一覧表示します。
POST/api/user_groups/:id/membersコラボレーターグループにメンバーを追加します。
DELETE/api/user_groups/:id/membersコラボレーターグループからメンバーを削除します。
GET/api/user_groups/:id/project_grantsコラボレーターグループのプロジェクト権限付与を一覧表示します。

コネクション

タイプリソース説明
GET/api/connectionsすべてのコネクションと関連データを返します。
POST/api/connectionsコネクションを作成します。
PUT/api/connections/:connection_idコネクションを更新します。
POST/api/connections/:connection_id/disconnectコネクションを切断します。
DELETE/api/connections/:connection_idコネクションを削除します。

コネクター

タイプリソース説明
GET/api/integrationsリクエストで指定されたコネクターとメタデータのリストを返します。
GET/api/integrations/all非埋め込みワークスペース内のすべてのコネクターと関連メタデータのページ分割されたリストを返します。 レスポンスには、標準コネクターとプラットフォームコネクターが含まれます。

カスタムコネクター

タイプリソース説明
GET/api/custom_connectorsカスタムコネクターを取得します。
POST/api/sdk/generate_schema/json文字列化されたJSONサンプルからWorkatoスキーマを生成します。
POST/api/sdk/generate_schema/csv文字列化されたCSVサンプルからWorkatoスキーマを生成します。

Custom OAuth profiles

タイプリソース説明
GET/api/custom_oauth_profilesCustom OAuth profilesを一覧表示します
GET/api/custom_oauth_profiles/:idID別にCustom OAuth profileを取得します
POST/api/custom_oauth_profilesCustom OAuth profileを作成します
PUT/api/custom_oauth_profiles/:idCustom OAuth profileを更新します
DELETE/api/custom_oauth_profiles/:idCustom OAuth profileを削除します

Data tables

テーブル管理API

ベース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を切り詰めます。

レコード操作API

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

タイプリソース説明
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ファイルをダウンロードするためのリンクを生成します。

Environment管理

タイプリソース説明
POST/api/secrets_management/clear_cacheSecrets managementキャッシュをクリアします。
GET/api/activity_logs活動監査ログレコードを取得します。
GET/api/tagsタグのリストを取得します。
POST/api/tagsタグを作成します。
PUT/api/tags/:handleタグを更新します。
DELETE/api/tags/:handleタグを削除します。

Environment properties

タイプリソース説明
GET/api/propertiesプレフィックスに一致するEnvironment propertiesの一覧を取得します。
POST/api/propertiesEnvironment propertiesを作成または更新します。

Environmentロール

タイプリソース説明
GET/api/environment_rolesEnvironmentロールを一覧表示します。
GET/api/environment_roles/:idEnvironmentロールの詳細を取得します。
POST/api/environment_rolesEnvironmentロールを作成します。
PUT/api/environment_roles/:idEnvironmentロールを更新します。
DELETE/api/environment_roles/:idEnvironmentロールを削除します。

Event streams

パブリックAPI

タイプリソース説明
POSTevent-streams.workato.com/api/v1/topics/:topic_id/consumeトピックからメッセージを消費します。
POSTevent-streams.workato.com/api/v1/topics/:topic_id/publishメッセージをトピックにパブリッシュします。
POSTevent-streams.workato.com/api/v1/batch/topics/:topic_id/publishメッセージのバッチをトピックにパブリッシュします。

Developer API

タイプリソース説明
GET/api/event_streams/topicsトピックのリストを取得します。
POST/api/event_streams/topicsトピックを作成します。
GET/api/event_streams/topics/:topic_idIDでトピックを取得します。
PUT/api/event_streams/topics/:topic_idトピックを更新します。
PUT/api/event_streams/topics/:topic_id/purgeトピックをパージします。
DELETE/api/event_streams/topics/:topic_idトピックを削除します。

フォルダ

タイプリソース説明
GET/api/foldersフォルダをリストします。
GET/api/projectsプロジェクトをリストします。
POST/api/foldersプロジェクトまたはフォルダを作成します。
PUT/api/folders/:folder_idフォルダを更新します。
PUT/api/projects/:project_idプロジェクトを更新します。
DELETE/api/folders/:folder_idフォルダを削除します。
DELETE/api/projects/:project_idプロジェクトを削除します。

ジョブ

タイプリソース説明
GET/api/recipes/:recipe_id/jobsレシピに属するジョブを一覧表示します。
GET/api/recipes/:recipe_id/jobs/:job_handle1つのジョブのメタデータを返します。
POST/api/job/resume指定したresume_tokenに基づいて特定のジョブを再開します。 このエンドポイントはHTTPステータスコード204を返し、レスポンスにコンテンツを含めずにリクエスト処理が成功したことを示します。 このエンドポイントはSDK Wait for resumeアクションで使用されます。
POST/api/recipes/:recipe_id/repeat_jobs指定したジョブを繰り返します。

レガシーロール

タイプリソース説明
GET/api/rolesカスタムロールの一覧表示。
PUT/api/roles/:role_idカスタムロールのプロジェクト権限を更新します。
POST/api/roles/:role_id/copyカスタムロールのコピーを作成します。

ルックアップ テーブル

タイプリソース説明
GET/api/lookup_tablesテーブルを一覧表示します。
GET/api/lookup_tables/:lookup_table_id/lookup行を検索します
GET/api/lookup_tables/:lookup_table_id/rows行を一覧表示します。
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行を削除します。

MCPサーバー

タイプリソース説明
GET/api/mcp/mcp_serversMCPサーバーを一覧表示します。
POST/api/mcp/mcp_serversMCPサーバーを作成します。
GET/api/mcp/mcp_servers/:handleMCPサーバーの詳細を取得します。
PUT/api/mcp/mcp_servers/:handleMCPサーバーを更新します。
DELETE/api/mcp/mcp_servers/:handleMCPサーバーを削除します。
POST/api/mcp/mcp_servers/:handle/token_renewMCPサーバーの認証トークンを更新します。
POST/api/mcp/mcp_servers/:handle/assign_toolsMCPサーバーにツールを割り当てます。
POST/api/mcp/mcp_servers/:handle/assign_user_groupsMCPサーバーにユーザーグループを割り当てます。
POST/api/mcp/mcp_servers/:handle/remove_user_groupsMCPサーバーからユーザーグループを削除します。
PUT/api/mcp/mcp_servers/:handle/update_folderMCPサーバーを別のフォルダに移動します。
GET/api/mcp/mcp_servers/:mcp_server_handle/server_policiesサーバーポリシー設定を取得します。
PUT/api/mcp/mcp_servers/:mcp_server_handle/server_policiesサーバーポリシー設定を更新します。
GET/api/mcp/mcp_servers/:mcp_server_handle/toolsMCPサーバーのツールを一覧表示します。
PUT/api/mcp/mcp_servers/:mcp_server_handle/tools/:idMCPのツール説明を更新します。
DELETE/api/mcp/mcp_servers/:mcp_server_handle/tools/:idツールを削除します。
GET/api/mcp/user_groupsIDプロバイダーのユーザーグループを一覧表示します。

プロジェクト

タイプリソース説明
POST/api/projects/:id/buildプロジェクトをビルドします。 プロジェクトビルドのデプロイエンドポイントを使用して、プロジェクトをEnvironmentにデプロイします。
GET/api/project_builds/:id一意のIDでプロジェクトビルドを取得します。
POST/api/project_builds/:id/deployプロジェクトビルドをEnvironmentにデプロイします。 プロジェクトのビルドエンドポイントを使用して、最初にプロジェクトをビルドします。
POST/api/projects/:id/deployプロジェクトをビルドし、Environmentにデプロイします。
GET/api/deployments/:id一意のIDで単一のデプロイメントを取得します。
GET/api/deploymentsデプロイメントのリストを取得します。 クエリパラメータを使用して、プロジェクト、フォルダ、または日付範囲で結果をフィルタリングします。
GET/api/deployments/:id/eligible_reviewersデプロイメントのレビューに割り当てることができる対象レビュー担当者のリストを取得します。
POST/api/deployments/:id/assign_reviewersデプロイメントにレビュー担当者を割り当てます。
POST/api/deployments/:id/submit_for_reviewデプロイメントをレビューのために送信します。
POST/api/deployments/:id/approveデプロイメントを承認します。
POST/api/deployments/:id/rejectデプロイメントを却下します。
POST/api/deployments/:id/reopenデプロイメントをレビュー用に再オープンします。
POST/api/deployments/:id/update_review_commentデプロイメントレビューコメントを更新します。
POST/api/deployments/:id/deploy承認済みデプロイメントをデプロイします。

プロジェクト権限付与

タイプリソース説明
GET/api/project_grants/:idプロジェクト権限付与を取得します。
PUT/api/project_grants/:idプロジェクト権限付与を更新します。
DELETE/api/project_grants/:idプロジェクト権限付与を削除します。
GET/api/projects/:id/project_grantsプロジェクトID別にプロジェクト権限付与を一覧表示します。
PUT/api/projects/:id/project_grantsプロジェクト権限付与を追加または更新します。

プロジェクトプロパティ

タイプリソース説明
GET/api/propertiesプレフィックスとプロジェクトIDに一致するプロジェクトレベルのプロパティを一覧表示します。
POST/api/propertiesプロジェクトレベルのプロパティをアップサートします。

プロジェクトロール

タイプリソース説明
GET/api/project_rolesプロジェクトロールを一覧表示します。
GET/api/project_roles/:idプロジェクトロールの詳細を取得します。
POST/api/project_rolesプロジェクトロールを作成します。
PUT/api/project_roles/:idプロジェクトロールを更新します。
DELETE/api/project_roles/:idプロジェクトロールを削除します。

レシピ

タイプリソース説明
GET/api/recipes/:idレシピの詳細を取得します。
POST/api/recipesレシピを作成します。
POST/api/recipesレシピをコピーします。
PUT/api/recipes/:idレシピを更新します。
GET/api/recipesユーザーに属するレシピを一覧表示します。
PUT/api/recipes/:id/startスタートレシピ。
PUT/api/recipes/:id/stopレシピを停止します。
DELETE/api/recipes/:idレシピを削除します。
POST/api/recipes/:recipe_id/reset_triggerレシピトリガーをリセットします。
PUT/api/recipes/:recipe_id/connect停止中のレシピ内のアプリケーションのコネクションを更新します。
POST/api/recipes/:recipe_id/poll_nowレシピのポーリングトリガーをアクティブ化します。
GET/api/recipes/:recipe_id/versionsレシピのバージョンを取得します。
GET/api/recipes/:recipe_id/versions/:idレシピバージョンの詳細を取得します。
PATCH/PUT/api/recipes/:recipe_id/versions/:idレシピバージョンのコメントを更新します。
GET/api/recipes/:recipe_id/healthレシピの最新の最適化レポートを取得します。
POST/api/recipes/:recipe_id/healthPerformance Copilotを使用してパフォーマンススキャンをキューに追加します。

レシピライフサイクルマネジメント

タイプリソース説明
GET/api/export_manifests/folder_assetsフォルダ内のアセットを表示します。
POSTapi/export_manifestsエクスポートマニフェストを作成します。
PUTapi/export_manifests/:idエクスポートマニフェストを更新します。
GETapi/export_manifests/:idエクスポートマニフェストを表示します。
DELETE/api/export_manifests/:idエクスポートマニフェストを削除します。
POST/api/packages/export/:manifest_idマニフェストに基づいてパッケージをエクスポートします。
POST/api/packages/import/:folder_idパッケージをフォルダにインポートします。
GET/api/packages/:idIDでパッケージを取得します。
GET/api/packages/:id/downloadパッケージをダウンロードします。

ロール移行

タイプリソース説明
POST/api/roles_migration/system_rolesシステムロールを移行します。
POST/api/roles_migration/custom_roleカスタムロールを移行します。

タグ割り当て

タイプリソース説明
POST/api/tags_assignmentsワークスペース内のアセットにタグを適用するか、アセットからタグを削除します。

テストAutomation

タイプリソース説明
POST/api/test_cases/run_requestsテストケースを実行します。
GET/api/test_cases/run_requests/{id}テストケース実行リクエストの現在の状態を取得します。
GET/api/recipes/{recipe_id}/test_casesテストケースを取得します。

ワークスペースコラボレーター

タイプリソース説明
POST/api/member_invitationsコラボレーターをワークスペースに招待します。
GET/api/membersコラボレーターのリストを取得します。
GET/api/members/:idコラボレーターの詳細を取得します。
PUT/api/members/:idコラボレーターロールを更新します。
DELETE/api/members/:idコラボレーターを削除します。
GET/api/members/:id/project_grantsコラボレーターのプロジェクト付与を一覧表示します。
GET/api/members/:id/privilegesコラボレーターの権限を取得します。
GET/api/members/:id/projects_privilegesコラボレーターのプロジェクト権限を取得します。

ワークスペース詳細

詳細の取得

タイプリソース説明
GET/api/users/meワークスペースに関する詳細を取得します。

Workato Identity IAM

タイプリソース説明
GET/api/iam/usersワークスペース内のユーザーを一覧表示します。
GET/api/iam/users/:user-idIDで特定のユーザーの詳細を取得します。
POST/api/iam/users1人以上の新規ユーザーを作成します。
PUT/api/iam/users/:user-id既存のユーザーを更新します。
DELETE/api/iam/users/:user-idワークスペースからユーザーを削除します。
POST/api/iam/users/:user-id/add_to_group特定のグループにユーザーを追加します。
POST/api/iam/users/:user-id/remove_from_group特定のグループからユーザーを削除します。
GET/api/iam/user_groups現在のEnvironment内のユーザーグループを一覧表示します。
GET/api/iam/user_groups/:user-group-idIDで特定のユーザーグループの詳細を取得します。
POST/api/iam/user_groups新しいユーザーグループを作成します。
PUT/api/iam/user_groups/:user-group-id既存のユーザーグループを更新します。
DELETE/api/iam/user_groups/:user-group-idユーザーグループを削除します。
POST/api/iam/user_groups/:user-group-id/add_users複数のユーザーをグループに追加します。
DELETE/api/iam/user_groups/:user-group-id/remove_usersグループから複数のユーザーを削除します。
GET/api/iam/user_groups/:user-group-id/membersユーザーグループのすべてのメンバーを一覧表示します。
GET/api/iam/app_links現在のEnvironment内のアプリリンクを一覧表示します。
POST/api/iam/app_linksアプリリンクを作成します。
DELETE/api/iam/app_links/:idIDでアプリリンクを削除します。
DELETE/api/iam/app_linksIDでアプリリンクを削除します。

Last updated: