製品アップデートステータスページWorkato Academy
English
日本語
トライアルを開始
Embedded API

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/:id/api_collectionsカスタマーワークスペース内のAPIコレクションを一覧表示します。
POST/api/managed_users/:id/api_collections顧客ワークスペース内にAPIコレクションを作成します。
GET/api/managed_users/:id/api_endpointsコレクション内のAPIエンドポイントを一覧表示します。
PUT/api/managed_users/:id/api_endpoints/:id/enableコレクション内のAPIエンドポイントを有効にします。
PUT/api/managed_users/:id/api_endpoints/:id/disableコレクション内のAPIエンドポイントを無効にします。
GET/api/managed_users/:id/api_clients顧客ワークスペース内のAPIクライアントを一覧表示します。 将来の非推奨化に備えるため、APIクライアントの一覧表示（v2）エンドポイントへの移行をお勧めします。
GET/api/v2/managed_users/:id/api_clientsカスタマーワークスペース内のすべてのAPIクライアントを一覧表示します。 Workatoは、APIクライアントが属するプロジェクトのproject_idをレスポンスに含めます。
POST/api/managed_users/:id/api_clients顧客ワークスペース内にAPIクライアントを作成します。 将来の非推奨化に備えるため、APIクライアントの作成（v2）エンドポイントへの移行をお勧めします。
POST/api/v2/managed_users/:id/api_clients指定したプロジェクト内のカスタマーワークスペースに新しいAPIクライアントを作成します。
GET/api/v2/managed_users/:id/api_clients/:api_client_id顧客ワークスペース内のAPIクライアントの詳細をIDで取得します。
PUT/api/v2/managed_users/:id/api_clients/:api_client_idカスタマーワークスペース内で指定したプロジェクト内の既存のAPIクライアントを更新します。
DELETE/api/v2/managed_users/:id/api_clients/:api_client_idカスタマーワークスペース内の既存のAPIクライアントを削除します。
GET/api/managed_users/:id/api_access_profiles顧客ワークスペース内でAPIクライアントに属するアクセスプロファイルを一覧表示します。 将来の非推奨化に備えるため、APIキーの一覧表示エンドポイントへの移行をお勧めします。
GET/api/v2/managed_users/:id/api_clients/:api_client_id/api_keysカスタマーワークスペース内のAPIクライアントのAPIキーを一覧表示します。
POST/api/managed_users/:id/api_access_profiles顧客ワークスペース内でAPIクライアントに属するアクセスプロファイルを作成します。 将来の非推奨化に備えるため、APIキーの作成エンドポイントへの移行をお勧めします。
POST/api/v2/managed_users/:id/api_clients/:api_client_id/api_keysカスタマーワークスペース内のAPIクライアントのAPIキーを作成します。
PUT/api/managed_users/:id/api_access_profiles顧客ワークスペース内でAPIクライアントに属するアクセスプロファイルを更新します。 将来の非推奨化に備えるため、APIキーの更新エンドポイントへの移行をお勧めします。
PUT/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_idカスタマーワークスペース内のAPIクライアントのAPIキーを更新します。
PUT/api/managed_users/:id/api_access_profiles/:api_access_profile_id/enable顧客ワークスペース内でAPIクライアントに属するアクセスプロファイルを有効化します。 将来の非推奨化に備えるため、APIキーの有効化エンドポイントへの移行をお勧めします。
PUT/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_id/enableカスタマーワークスペース内のAPIクライアントのAPIキーを有効にします。
PUT/api/managed_users/:id/api_access_profiles顧客ワークスペース内でAPIクライアントに属するアクセスプロファイルを無効化します。 将来の非推奨化に備えるため、APIキーの無効化エンドポイントへの移行をお勧めします。
PUT/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_id/disableカスタマーワークスペース内のAPIクライアントのAPIキーを無効にします。
PUT/api/managed_users/:id/api_access_profiles/:id/refresh_secretアクセスプロファイルのトークンまたはシークレットを更新します。 将来の非推奨化に備えるため、APIキーシークレットの更新エンドポイントへの移行をお勧めします。
POST/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_id/refresh_secretカスタマーワークスペース内のAPIキーの認証トークンまたはOAuth 2.0クライアントシークレットを更新します。
DELETE/api/v2/managed_users/:id/api_clients/:api_client_id/api_keys/:api_key_idカスタマーワークスペース内の既存のAPIキーを削除します。
GET/api/v2/managed_users/:id/api_portalsカスタマーワークスペース内のAPIクライアントに関連付けられているすべてのAPIポータルを一覧表示します。

コラボレーターグループ ​

タイプリソース説明
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/connectionsEmbeddedベンダーが顧客ワークスペース内にシェルコネクションを追加できるようにします。
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/allEmbeddedパートナーのアカウント内のすべてのコネクターと関連メタデータのページ分割されたリストを返します。 レスポンスには標準コネクタとカスタムコネクタが含まれます。

カスタムコネクター ​

タイプリソース説明
GET/api/custom_connectorsカスタムコネクターを取得します。
GET/api/custom_connectors/:idカスタムコネクタをIDで取得
POST/api/custom_connectors/:id/oem_share/:version共有コネクタを作成または更新
POSTapi/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/assignCustom OAuth profileを顧客ワークスペースに割り当てます
DELETE/api/managed_users/:managed_user_id/custom_oauth_profiles/:id/unassignCustom 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_idIDでData tablesを取得します。
POST/api/v2/managed_users/:managed_user_id/data_tablesData tablesを作成します。
PUT/api/v2/managed_users/:managed_user_id/data_tables/:data_table_idData tablesを更新します。
DELETE/api/v2/managed_users/:managed_user_id/data_tables/:data_table_idData tablesを削除します。
POST /api/v2/managed_users/:managed_user_id/data_tables/:data_table_id/truncateData 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ファイルをダウンロードするためのリンクを生成します。

レコードインポートAPI ​

ベースURL: https://data-tables.workato.com。ファイルをアップロードは例外で、https://file-storage.workato.comを使用します。

タイプリソース説明
POST/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/file/upload_linkファイルをアップロードするためのリンクを作成します。
POST/sharing/files署名付きリンクにファイルをアップロードします。
DELETE/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/fileアップロード済みファイルを削除します。
GET/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/fileアップロード済みファイルの詳細を返します。
POST/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/import/startアップロード済みファイルからレコードのインポートを開始します。
DELETE/api/v1/managed_users/:managed_user_id/tables/:data_table_id/records/importインポートを破棄またはキャンセルします。

動的フィールドマッピング ​

タイプリソース説明
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顧客ワークスペース内で指定したジョブを再実行します。
タイプリソース説明
PUT/api/account/signature_verification_keyJWT署名検証キーを更新します。

レガシーロール ​

タイプリソース説明
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ルックアップ テーブル内の行を削除します。

顧客の管理 ​

タイプリソース説明
POST/api/managed_users顧客を作成します。
PUT/api/managed_users/:id顧客を更新します。
DELETE/api/managed_users/:id顧客を削除します。
GET/api/managed_users/:id顧客を取得します。
GET/api/managed_usersすべての顧客を一覧表示します。
GET/api/managed_users/:id/members顧客ワークスペース内のコラボレーターのリストを取得します。
GET/api/managed_users/:id/members/:member_id顧客ワークスペースのコラボレーター詳細を取得します。
POST/api/managed_users/:id/members顧客ワークスペースにコラボレーターを追加します。
PUT/api/managed_users/:id/members/:member_id顧客ワークスペースのコラボレーターを更新します。
DELETE/api/managed_users/:id/members/:member_id顧客ワークスペースからコラボレーターを削除します。
GET/api/managed_users/:id/members/:member_id/project_grants顧客ワークスペースのコラボレーターのプロジェクト付与を一覧表示します。
GET/api/managed_users/:id/connections顧客ワークスペース内のコネクションを一覧表示します。
GET/api/managed_users/:id/members/:member_id/privileges顧客ワークスペースのコラボレーターから権限を取得します。
GET/api/managed_users/:managed_user_id/members/:id/projects_privileges顧客ワークスペースのコラボレーターからプロジェクト権限を取得します。
POST/api/v2/managed_users/statistics/usageより詳細なデータ粒度で、顧客ワークスペースの利用状況メトリクスを取得します。
POST/api/v2/managed_users/statistics/connection_usage指定した顧客ワークスペースのコネクションベースの利用状況メトリクスを取得します。
GET/api/managed_users/usageすべての顧客のタスク利用状況を月別に取得します。
POST/api/managed_users/:id/environments既存の顧客にEnvironmentをプロビジョニングします。
GET/api/v2/managed_users/customer_categoriesEmbeddedパートナーのワークスペース内の顧客カテゴリを一覧表示します。
POST/api/v2/managed_users/customer_categories顧客カテゴリを作成します。
PUT/api/v2/managed_users/customer_categories/:id顧客カテゴリを更新します。
DELETE/api/v2/managed_users/customer_categories/:id顧客カテゴリを削除します。
POST/api/v2/managed_users/customer_categories/:id/assign顧客カテゴリをワークスペースに一括割り当てします。
POST/api/v2/managed_users/customer_categories/:id/unassign顧客カテゴリのワークスペースへの割り当てを一括解除します。

MCPサーバー ​

タイプリソース説明
GET/api/managed_users/:managed_user_id/mcp_servers顧客ワークスペース内のMCPサーバーを一覧表示します。
POST/api/managed_users/:managed_user_id/mcp_servers顧客ワークスペース内にMCPサーバーを作成します。
GET/api/managed_users/:managed_user_id/mcp_servers/:handle顧客ワークスペース内のMCPサーバーの詳細を取得します。
PUT/api/managed_users/:managed_user_id/mcp_servers/:handle顧客ワークスペース内のMCPサーバーを更新します。
DELETE/api/managed_users/:managed_user_id</br/>mcp_servers/:handle顧客ワークスペース内のMCPサーバーを削除します。
POST/api/managed_users/:managed_user_id/mcp_servers/:handle/token_renew顧客ワークスペース内のMCPサーバー認証トークンを更新します。
POST/api/managed_users/:managed_user_id/mcp_servers/:handle/assign_tools顧客ワークスペース内のMCPサーバーにツールを割り当てます。
POST/api/managed_users/:managed_user_id/mcp_servers/:handle/assign_user_groups顧客ワークスペース内のMCPサーバーにユーザーグループを割り当てます。
POST/api/managed_users/:managed_user_id/mcp_servers/:handle/remove_user_groups顧客ワークスペース内のMCPサーバーからユーザーグループを削除します。
PUT/api/managed_users/:managed_user_id/mcp_servers/:handle/update_folder顧客ワークスペース内のMCPサーバーを別のフォルダに移動します。
GET/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/server_policies顧客ワークスペース内のサーバーポリシー設定を取得します。
PUT/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/server_policies顧客ワークスペース内のサーバーポリシー設定を更新します。
GET/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/tools顧客ワークスペース内のMCPサーバーのツールを一覧表示します。
PUT/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/tools/:id顧客ワークスペース内のツールの説明を更新します。
DELETE/api/managed_users/:managed_user_id/mcp_servers/:mcp_server_handle/tools/:id顧客ワークスペース内のツールを削除します。
GET/api/managed_users/:managed_user_id/user_groups顧客ワークスペース内のIDプロバイダーユーザーグループを一覧表示します。

オンプレミス ​

タイプリソース説明
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_idIDを使用して、カスタマーワークスペース内の特定のオンプレミスエージェントの詳細を取得します。

ピックリスト ​

タイプリソース説明
POST/api/managed_users/:id/connections/:connection_id/pick_listEmbedded顧客ワークスペース内の指定したコネクションのピックリスト値の一覧を取得します。

プロジェクト権限付与 ​

タイプリソース説明
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顧客ワークスペースからプロジェクトロールを削除します。

プロジェクト ​

タイプリソース説明
GET/api/managed_users/:managed_user_id/projectsカスタマーワークスペース内のプロジェクトを一覧表示します。
POST/api/managed_users/:managed_user_id/foldersカスタマーワークスペース内にプロジェクトを作成します。
PUT/api/managed_users/:managed_user_id/projects/:project_idカスタマーワークスペース内のプロジェクトを更新します。
DELETE/api/managed_users/:managed_user_id/projects/:project_idカスタマーワークスペース内のプロジェクトを削除します。
GET/api/managed_users/:managed_user_id/propertiesプレフィックスおよびプロジェクトIDでプロジェクトレベルのプロパティを一覧表示します。
POST/api/managed_users/:managed_user_id/propertiesプロジェクトレベルのプロパティをアップサートします。
GET/api/managed_users/:managed_user_id/deploymentsカスタマーワークスペース内のデプロイメントのリストを取得します。
GET/api/managed_users/:managed_user_id/deployments/:idカスタマーワークスペース内の単一のデプロイメントを取得します。
GET/api/managed_users/:managed_user_id/api/project_builds/:idカスタマーワークスペース内のダウンロード済みパッケージを取得します。
POST/api/managed_users/:managed_user_id/projects/:id/buildカスタマーワークスペース内でプロジェクトをビルドします。
POST/api/managed_users/:managed_user_id/project_builds/:id/deployカスタマーワークスペース内でダウンロード済みパッケージをデプロイします。
POST/api/managed_users/:managed_user_id/projects/:project_id/deployカスタマーワークスペース内でプロジェクトをデプロイします。
GET/api/managed_users/:managed_user_id/deployments/:id/eligible_reviewersカスタマーワークスペース内のデプロイメントをレビューするために割り当て可能な対象レビュー担当者のリストを取得します。
POST/api/managed_users/:managed_user_id/deployments/:id/assign_reviewersカスタマーワークスペース内のデプロイメントにレビュー担当者を割り当てます。
POST/api/managed_users/:managed_user_id/deployments/:id/submit_for_reviewカスタマーワークスペース内のデプロイメントをレビュー用に送信します。
POST/api/managed_users/:managed_user_id/deployments/:id/deployカスタマーワークスペース内で承認済みデプロイメントをデプロイします。

レシピ ​

タイプリソース説明
GET/api/managed_users/:id/recipes顧客に属するレシピを一覧表示します。
GET/api/managed_users/:id/recipes/:recipe_id顧客に属するレシピの詳細を取得します。
POST/api/managed_users/:managed_user_id/recipes顧客ワークスペース内にレシピを作成します。
PUT/api/managed_users/:managed_user_id/recipes/:id顧客ワークスペース内のレシピを更新します。
POST/api/managed_users/:id/recipes/:recipe_id/copy顧客ワークスペース内のレシピをコピーします。
DELETE/api/managed_users/:id/recipes/:recipe_id顧客ワークスペース内のレシピを削除します。
PUT/api/managed_users/:managed_user_id/recipes/:recipe_id/start顧客ワークスペース内のレシピを開始します。
PUT/api/managed_users/:managed_user_id/recipes/:recipe_id/stop顧客ワークスペース内のレシピを停止します。
POST/api/managed_users/:managed_user_id/recipes/:recipe_id/reset_trigger顧客ワークスペース内のレシピのトリガーをリセットします。
POST/api/managed_users/:managed_user_id/recipes/:recipe_id/poll_nowpoll-nowレシピを開始します。
POST/api/managed_users/:managed_user_id/recipes/:recipe_id/force_run顧客ワークスペースでレシピをオンデマンドで強制実行します。
GET/api/v2/managed_users/:managed_user_id/recipes/:recipe_id/versions顧客に属するレシピのバージョンを取得します。
GET/api/v2/managed_users/:managed_user_id/recipes/:recipe_id/versions/:id顧客に属するレシピバージョンの詳細を取得します。
PATCH/PUT/api/v2/managed_users/:managed_user_id/recipes/:recipe_id/versions/: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顧客ワークスペース内のテストケース実行リクエストの現在の状態を取得します。

最終更新日: