Workato APIリソース
Agent Studio
APIクライアント
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/developer_api_clients | Developer APIクライアントの一覧を表示します。 |
| POST | /api/developer_api_clients | Developer APIクライアントを作成します。 |
| GET | /api/developer_api_clients/:id | ID別のDeveloper APIクライアントを取得します。 |
| PUT | /api/developer_api_clients/:id | Developer APIクライアントを更新します。 |
| DELETE | /api/developer_api_clients/:id | Developer APIクライアントを削除します。 |
| POST | /api/developer_api_clients/:id/regenerate | Developer APIクライアントトークンを再生成します。 |
| GET | /api/developer_api_client_roles | Developer APIクライアントロールの一覧を表示します。 |
API platform
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/api_collections | APIコレクションを一覧表示します。 |
| POST | /api/api_collections | APIコレクションを作成します。 |
| GET | /api/api_endpoints | コレクション内のAPIエンドポイントを一覧表示します。 |
| PUT | /api/api_endpoints/:id/enable | コレクション内のAPIエンドポイントを有効化します。 |
| PUT | /api/api_endpoints/:id/disable | コレクション内のAPIエンドポイントを無効化します。 |
| GET | /api/api_clients | APIクライアントを一覧表示します。 将来の廃止に備えて、APIクライアントの一覧表示(v2)エンドポイントへ移行することをお勧めします。 |
| GET | /api/v2/api_clients | すべてのAPIクライアントを一覧表示します。 Workatoは、APIクライアントに関連付けられたプロジェクトのproject_idをレスポンスに含めます。 |
| POST | /api/api_clients | APIクライアントを作成します。 将来の廃止に備えて、APIクライアントの作成(v2)エンドポイントへ移行することをお勧めします。 |
| POST | /api/v2/api_clients | 指定したプロジェクト内に新しいAPIクライアントを作成します。 |
| GET | /api/v2/api_clients/:api_client_id | IDでAPIクライアントの詳細を取得します。 |
| PUT | /api/v2/api_clients/:api_client_id | 指定したプロジェクト内の既存のAPIクライアントを更新します。 |
| DELETE | /api/v2/api_clients/:api_client_id | 既存のAPIクライアントを削除します。 |
| GET | /api/api_access_profiles | APIクライアントに属するアクセスプロファイルを一覧表示します。 将来の廃止に備えて、APIキーの一覧表示エンドポイントへ移行することをお勧めします。 |
| GET | /api/v2/api_clients/:api_client_id/api_keys | APIクライアントのAPI keyを一覧表示します。 |
| POST | /api/api_access_profiles | APIクライアントに属するアクセスプロファイルを作成します。 将来の廃止に備えて、APIキーの作成エンドポイントへ移行することをお勧めします。 |
| POST | /api/v2/api_clients/:api_client_id/api_keys | APIクライアントのAPI keyを作成します。 |
| PUT | /api/api_access_profiles | APIクライアントに属するアクセスプロファイルを更新します。 将来の廃止に備えて、APIキーの更新エンドポイントへ移行することをお勧めします。 |
| PUT | /api/v2/api_clients/:api_client_id/ api_keys/:api_key_id | APIクライアントのAPI keyを更新します。 |
| PUT | /api_access_profiles | APIクライアントに属するアクセスプロファイルを有効化します。 将来の廃止に備えて、APIキーの有効化エンドポイントへ移行することをお勧めします。 |
| PUT | /api/v2/api_clients/:api_client_id/ api_keys/:api_key_id/enable | APIクライアントのAPI keyを有効化します。 |
| PUT | /api_access_profiles | APIクライアントに属するアクセスプロファイルを無効化します。 将来の廃止に備えて、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_profiles | Custom OAuth profilesを一覧表示します |
| GET | /api/custom_oauth_profiles/:id | ID別にCustom OAuth profileを取得します |
| POST | /api/custom_oauth_profiles | Custom OAuth profileを作成します |
| PUT | /api/custom_oauth_profiles/:id | Custom OAuth profileを更新します |
| DELETE | /api/custom_oauth_profiles/:id | Custom OAuth profileを削除します |
Data tables
テーブル管理API
ベースURL: https://www.workato.com
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/data_tables | すべてのData tablesを一覧表示します。 |
| GET | /api/data_tables/:data_table_id | IDでData tablesを取得します。 |
| POST | /api/data_tables | Data tablesを作成します。 |
| PUT | /api/data_tables/:data_table_id | Data tablesを更新します。 |
| DELETE | /api/data_tables/:data_table_id | Data tablesを削除します。 |
| POST | /api/data_tables/:data_table_id/truncate | Data 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_cache | Secrets 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/properties | Environment propertiesを作成または更新します。 |
Environmentロール
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/environment_roles | Environmentロールを一覧表示します。 |
| GET | /api/environment_roles/:id | Environmentロールの詳細を取得します。 |
| POST | /api/environment_roles | Environmentロールを作成します。 |
| PUT | /api/environment_roles/:id | Environmentロールを更新します。 |
| DELETE | /api/environment_roles/:id | Environmentロールを削除します。 |
Event streams
パブリックAPI
| タイプ | リソース | 説明 |
|---|---|---|
| POST | event-streams.workato.com/api/v1/topics/:topic_id/consume | トピックからメッセージを消費します。 |
| POST | event-streams.workato.com/api/v1/topics/:topic_id/publish | メッセージをトピックにパブリッシュします。 |
| POST | event-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_id | IDでトピックを取得します。 |
| 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_handle | 1つのジョブのメタデータを返します。 |
| 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_servers | MCPサーバーを一覧表示します。 |
| POST | /api/mcp/mcp_servers | MCPサーバーを作成します。 |
| GET | /api/mcp/mcp_servers/:handle | MCPサーバーの詳細を取得します。 |
| PUT | /api/mcp/mcp_servers/:handle | MCPサーバーを更新します。 |
| DELETE | /api/mcp/mcp_servers/:handle | MCPサーバーを削除します。 |
| POST | /api/mcp/mcp_servers/:handle/token_renew | MCPサーバーの認証トークンを更新します。 |
| POST | /api/mcp/mcp_servers/:handle/assign_tools | MCPサーバーにツールを割り当てます。 |
| POST | /api/mcp/mcp_servers/:handle/assign_user_groups | MCPサーバーにユーザーグループを割り当てます。 |
| POST | /api/mcp/mcp_servers/:handle/remove_user_groups | MCPサーバーからユーザーグループを削除します。 |
| PUT | /api/mcp/mcp_servers/:handle/update_folder | MCPサーバーを別のフォルダに移動します。 |
| 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/tools | MCPサーバーのツールを一覧表示します。 |
| PUT | /api/mcp/mcp_servers/:mcp_server_handle/tools/:id | MCPのツール説明を更新します。 |
| DELETE | /api/mcp/mcp_servers/:mcp_server_handle/tools/:id | ツールを削除します。 |
| GET | /api/mcp/user_groups | IDプロバイダーのユーザーグループを一覧表示します。 |
プロジェクト
| タイプ | リソース | 説明 |
|---|---|---|
| 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/health | Performance Copilotを使用してパフォーマンススキャンをキューに追加します。 |
レシピライフサイクルマネジメント
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/export_manifests/folder_assets | フォルダ内のアセットを表示します。 |
| POST | api/export_manifests | エクスポートマニフェストを作成します。 |
| PUT | api/export_manifests/:id | エクスポートマニフェストを更新します。 |
| GET | api/export_manifests/:id | エクスポートマニフェストを表示します。 |
| DELETE | /api/export_manifests/:id | エクスポートマニフェストを削除します。 |
| POST | /api/packages/export/:manifest_id | マニフェストに基づいてパッケージをエクスポートします。 |
| POST | /api/packages/import/:folder_id | パッケージをフォルダにインポートします。 |
| GET | /api/packages/:id | IDでパッケージを取得します。 |
| 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
Last updated: