Embedded APIリソース
APIクライアント
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/v2/managed_users/:id/ developer_api_clients | 顧客ワークスペース内のすべてのDeveloper APIクライアントを一覧表示します。 |
| POST | /api/v2/managed_users/:id/ developer_api_clients | 顧客ワークスペース内に新しいDeveloper APIクライアントを作成します。 |
| GET | /api/v2/managed_users/:id/ developer_api_clients/:id | 顧客ワークスペース内のDeveloper APIクライアントの詳細をIDで取得します。 |
| PUT | /api/v2/managed_users/:id/ developer_api_clients/:id | 顧客ワークスペース内の既存のDeveloper APIクライアントを更新します。 |
| DELETE | /api/v2/managed_users/:id/ developer_api_clients/:id | 顧客ワークスペース内の既存のDeveloper APIクライアントを削除します。 |
| POST | /api/v2/managed_users/:id/ developer_api_clients/:id/regenerate | 顧客ワークスペース内のDeveloper APIクライアントのトークンを再生成します。 |
| GET | /api/v2/managed_users/:managed_user_id/ developer_api_client_roles | 顧客ワークスペース内のDeveloper APIクライアントロールを一覧表示します。 |
| POST | /api/v2/managed_users/:managed_user_id/ developer_api_client_roles/:id/copy | 顧客ワークスペース内のDeveloper APIクライアントロールをコピーします。 |
API platform
コラボレーターグループ
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/user_groups | カスタマーワークスペースのコラボレーターグループを一覧表示します。 |
| GET | /api/managed_users/:managed_user_id/user_groups/:id | カスタマーワークスペースのコラボレーターグループの詳細を取得します。 |
| POST | /api/managed_users/:managed_user_id/user_groups | カスタマーワークスペースのコラボレーターグループを作成します。 |
| PUT | /api/managed_users/:managed_user_id/user_groups/:id | カスタマーワークスペースのコラボレーターグループを更新します。 |
| DELETE | /api/managed_users/:managed_user_id/user_groups/:id | カスタマーワークスペースのコラボレーターグループを削除します。 |
| GET | /api/managed_users/:managed_user_id/user_groups/ :id/members | カスタマーワークスペース内のコラボレーターグループメンバーを一覧表示します。 |
| POST | /api/managed_users/:managed_user_id/user_groups/ :id/members | カスタマーワークスペースのコラボレーターグループにメンバーを追加します。 |
| DELETE | /api/managed_users/:managed_user_id/user_groups/ :id/members | カスタマーワークスペースのコラボレーターグループからメンバーを削除します。 |
| GET | /api/managed_users/:managed_user_id/user_groups/ :id/project_grants | カスタマーワークスペースのコラボレーターグループのプロジェクト権限付与を一覧表示します。 |
コネクション
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/connections /:adapter_name/input_schema | コネクションの入力に基づいて入力スキーマを返します。 |
| GET | /api/managed_users/:managed_user_id/ connections | 顧客ワークスペース内のコネクションの一覧を返します。 |
| POST | /api/managed_users/:managed_user_id/ connections | Embeddedベンダーが顧客ワークスペース内にシェルコネクションを追加できるようにします。 |
| PUT | /api/managed_users/:managed_user_id/ connections/:connection_id | 顧客ワークスペース内のコネクションを更新します。 |
| POST | /api/managed_users/:managed_user_id/ connections/:connection_id/disconnect | 顧客ワークスペース内のコネクションを切断します。 |
| DELETE | /api/managed_users/:managed_user_id/ connections/:connection_id | 顧客ワークスペース内のコネクションを削除します。 |
コネクター
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/v2/managed_users/:managed_user_id/connectors /:connector_name/input_schema | ベース入力スキーマを返します。 スキーマは静的であり、特定のコネクション入力は考慮されません。 |
| GET | /api/integrations | コネクタメタデータをクエリします。 |
| GET | /api/integrations/all | Embeddedパートナーのアカウント内のすべてのコネクターと関連メタデータのページ分割されたリストを返します。 レスポンスには標準コネクタとカスタムコネクタが含まれます。 |
カスタムコネクター
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/custom_connectors | カスタムコネクターを取得します。 |
| GET | /api/custom_connectors/:id | カスタムコネクタをIDで取得 |
| POST | /api/custom_connectors/:id/ oem_share/:version | 共有コネクタを作成または更新 |
| POST | api/managed_users/:managed_user_id/ recipes/:recipe_id/share | カスタムコネクタを含むレシピをEmbeddedパートナーと共有します。 |
| DELETE | /api/custom_connectors/:id/ suppress_oem_version | 共有コネクタを削除 |
Custom OAuth profiles
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/managed_users/:managed_user_id/ custom_oauth_profiles/:id/assign | Custom OAuth profileを顧客ワークスペースに割り当てます |
| DELETE | /api/managed_users/:managed_user_id/ custom_oauth_profiles/:id/unassign | Custom OAuth profileを顧客ワークスペースから割り当て解除します。 |
カスタマーマネージャー
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/customer_managers | すべてのカスタマーマネージャーを一覧表示します。 |
| PUT | /api/customer_managers/:id | カスタマーマネージャーを更新します。 |
| POST | /api/customer_managers | 新しいカスタマーマネージャーを作成します。 |
| DELETE | /api/customer_managers/:id | カスタマーマネージャーを削除します。 |
顧客ワークスペースのコラボレーター
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/managed_users/:id/member_invitation | 管理対象の顧客ワークスペースにコラボレーターを招待します。 |
データリテンション
| タイプ | リソース | 説明 |
|---|---|---|
| PUT | /api/managed_users/:managed_user_id/update_data_retention | 顧客ワークスペースのデータリテンション期間を更新します。 |
Data tables
テーブル管理API
ベース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_tables | Data 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を切り詰めます。 |
レコード操作API
ベース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 | ファイルをダウンロードするためのリンクを生成します。 |
動的フィールドマッピング
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/v2/managed_users/:managed_user_id /recipes/:recipe_id/field_map_introspections | 特定のレシピ内のすべてのフィールドマップイントロスペクションを一覧表示します。 |
| GET | /api/v2/managed_users/:managed_user_id /recipes/:recipe_id/field_map_introspections/:id | 特定のフィールドマップスキーマのフィールドマップイントロスペクションを一覧表示します。 |
| PUT | /api/v2/managed_users/:managed_user_id /recipes/:recipe_id/field_map_introspections/:id | 特定のフィールドマップスキーマのフィールドマッピングを更新します。 |
| POST | /api/v2/managed_users/:managed_user_id /recipes/:recipe_id/field_map_introspections/:id /refresh_schema | レシピのスキーマを更新してフィールドマップイントロスペクションを更新します。 |
| POST | /api/v2/managed_users/:managed_user_id /recipes/:recipe_id/field_map_introspections/:id/pick_list | レシピのフィールドマップイントロスペクション内の特定フィールドのピックリスト値を取得します。 |
Environment管理
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:id/activity_logs | 顧客ワークスペース内の活動監査ログレコードを取得します。 |
| GET | /api/v2/managed_users/:id/tags | 顧客ワークスペース内のタグの一覧を取得します。 |
| POST | /api/v2/managed_users/:id/tags | 顧客ワークスペース内にタグを作成します。 |
| PUT | /api/v2/managed_users/:id/tags/:handle | 顧客ワークスペース内のタグを更新します。 |
| DELETE | /api/v2/managed_users/:id/tags/:handle | 顧客ワークスペース内のタグを削除します。 |
Environment properties
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/properties | プレフィックスに一致する、顧客ワークスペースに属するEnvironment propertiesの一覧を返します。 |
| POST | /api/managed_users/:managed_user_id/properties | 顧客ワークスペースにEnvironment propertiesをアップサートします。 |
Environmentロール
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/environment_roles | 顧客ワークスペース内のEnvironmentロールを一覧表示します。 |
| GET | /api/managed_users/:managed_user_id/environment_roles/:id | 顧客ワークスペースからEnvironmentロールを取得します。 |
| POST | /api/managed_users/:managed_user_id/environment_roles | 顧客ワークスペース内にEnvironmentロールを作成します。 |
| PUT | /api/managed_users/:managed_user_id/environment_roles/:id | 顧客ワークスペース内のEnvironmentロールを更新します。 |
| DELETE | /api/managed_users/:managed_user_id/environment_roles/:id | 顧客ワークスペース内のEnvironmentロールを削除します。 |
Environment
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/managed_users/:id/environments | 既存の顧客にEnvironmentをプロビジョニングします。 プロビジョニング後、顧客ワークスペース内の既存のアセットはDevelopment Environmentに配置されます。 |
| POST | /api/v2/managed_users/:managed_user_id/environments | 既存の顧客にEnvironments V2をプロビジョニングします。 プロビジョニング後、顧客ワークスペース内の既存のアセットはプロダクション Environmentに配置されます。 |
| GET | /api/v2/managed_users/environments_provision_tasks/:id | 非同期Environmentプロビジョニングのステータスを取得します。 |
フォルダ
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/folders | 顧客ワークスペース内のフォルダを一覧表示します。 |
| POST | /api/managed_users/:managed_user_id/folders | 顧客ワークスペース内にフォルダを作成します。 |
| PUT | /api/managed_users/:managed_user_id/folders/:folder_id | 顧客ワークスペース内のフォルダを更新します。 |
| DELETE | /api/managed_users/:managed_user_id/folders/:folder_id | 顧客ワークスペース内のフォルダを削除します。 |
ジョブ
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:id/recipes/:recipe_id/jobs | レシピのジョブを一覧表示します。 |
| GET | /api/managed_users/:id/recipes/:recipe_id/jobs/:job_id | ジョブの詳細を取得します。 |
| POST | /api/managed_users/:managed_user_id/recipes/:recipe_id/repeat_jobs | 顧客ワークスペース内で指定したジョブを再実行します。 |
JWT直接リンク設定
| タイプ | リソース | 説明 |
|---|---|---|
| PUT | /api/account/signature_verification_key | JWT署名検証キーを更新します。 |
レガシーロール
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:id/roles | 顧客ワークスペース内のカスタムロールを一覧表示します。 |
| POST | /api/managed_users/:id/roles/:role_id/copy | カスタムロールのコピーを作成します。 |
ルックアップ テーブル
| タイプ | リソース | 説明 |
|---|---|---|
| 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 | ルックアップ テーブル内の行を削除します。 |
顧客の管理
MCPサーバー
オンプレミス
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/v2/managed_users/:id/on_prem_groups | カスタマーワークスペース内のオンプレミスグループを一覧表示します。 |
| GET | /api/v2/managed_users/:id/on_prem_agents | カスタマーワークスペース内のオンプレミスエージェントを一覧表示します。 |
| GET | /api/v2/managed_users/:id/on_prem_agents/:agent_id | IDを使用して、カスタマーワークスペース内の特定のオンプレミスエージェントの詳細を取得します。 |
ピックリスト
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/managed_users/:id/connections/:connection_id/pick_list | Embedded顧客ワークスペース内の指定したコネクションのピックリスト値の一覧を取得します。 |
プロジェクト権限付与
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/project_grants/:id | 顧客ワークスペースのプロジェクトグラントを取得します。 |
| PUT | /api/managed_users/:managed_user_id/project_grants/:id | 顧客ワークスペースのプロジェクトグラントを更新します。 |
| DELETE | /api/managed_users/:managed_user_id/project_grants/:id | 顧客ワークスペースのプロジェクトグラントを削除します。 |
| GET | /api/managed_users/:managed_user_id/:id/project_grants | 顧客ワークスペース内の特定のプロジェクトからグラントを一覧表示します。 |
| PUT | /api/managed_users/:managed_user_id/projects/ :id/project_grants | 顧客ワークスペースのプロジェクトグラントを追加または更新します。 |
プロジェクトロール
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/project_roles | 顧客ワークスペース内のプロジェクトロールを一覧表示します。 |
| GET | /api/managed_users/:managed_user_id/project_roles/:id | 顧客ワークスペースからプロジェクトロールを取得します。 |
| POST | /api/managed_users/:managed_user_id/project_roles | 顧客ワークスペースにプロジェクトロールを作成します。 |
| PUT | /api/managed_users/:managed_user_id/project_roles/:id | 顧客ワークスペース内のプロジェクトロールを更新します。 |
| DELETE | /api/managed_users/:managed_user_id/project_roles/:id | 顧客ワークスペースからプロジェクトロールを削除します。 |
プロジェクト
レシピ
レシピライフサイクルマネジメント
パッケージをエクスポートするAPIをお探しですか。 Workato APIドキュメントを参照してください。
これらのエンドポイントを使用できるユーザー
このガイドのエンドポイントはEmbedded Partner APIです。 詳細については、Workato担当者にお問い合わせください。
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/managed_users/:managed_user_id/ export_manifests/folder_assets | フォルダ内のアセットを表示します。 |
| POST | /api/managed_users/:managed_user_id/export_manifests | エクスポートマニフェストを作成します。 |
| PUT | /api/managed_users/:managed_user_id/export_manifests/:id | エクスポートマニフェストを更新します。 |
| GET | /api/managed_users/:managed_user_id/export_manifests/:id | エクスポートマニフェストを表示します。 |
| DELETE | /api/managed_users/:managed_user_id/export_manifests/:id | エクスポートマニフェストを削除します。 |
| POST | /api/managed_users/:managed_user_id/imports | 顧客ワークスペース内にあるフォルダにパッケージをインポートします。 |
| GET | /api/managed_users/:managed_user_id/recipes | インポートされたパッケージのステータスを取得します。 |
| POST | /api/managed_users/:managed_user_id/exports/:manifest_id | マニフェストIDに基づいてパッケージをエクスポートします。 Embeddedワークスペースが必要です。 |
| GET | /api/managed_users/:managed_user_id/exports/:package_id | パッケージエクスポートのステータスを返します。 Embeddedワークスペースが必要です。 |
ロール移行
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/managed_users/:managed_user_id/ roles_migration/system_roles | 顧客ワークスペースからシステムロールを移行します。 |
| POST | /api/managed_users/:managed_user_id/ roles_migration/custom_role | 顧客ワークスペースからカスタムロールを移行します。 |
タグ割り当て
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/v2/managed_users/:id/tags_assignments | 顧客ワークスペース内のアセットタグを適用または削除します。 |
テストAutomation
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/managed_users/:managed_user_id/ test_cases/run_requests | 顧客ワークスペースでテストケースを実行します。 |
| GET | /api/managed_users/:managed_user_id/recipes/ :recipe_id/test_cases | 顧客ワークスペース内の特定のレシピのテストケースを一覧表示します。 |
| GET | /api/managed_users/:managed_user_id/test_cases/ run_requests/:test_id | 顧客ワークスペース内のテストケース実行リクエストの現在の状態を取得します。 |
Last updated: