Workato API のリソース

プロジェクト

タイプ	リソース	説明
POST	/api/projects/:id/build	プロジェクトを作成します。プロジェクトを環境にデプロイメントするには、プロジェクトビルドのデプロイメントエンドポイントを使用します。
GET	/api/project_builds/:id	一意の ID でプロジェクトビルドを取得します。
POST	/api/project_builds/:id/deploy?environment_type=:environment_type	プロジェクトビルドを環境にデプロイメントします。プロジェクトを先にビルドするには、プロジェクトの作成エンドポイントを使用します。
POST	/api/projects/:id/deploy?environment_type=:environment_type	プロジェクトを作成して、環境にデプロイメントします。
GET	/api/deployments/:id	一意の ID で1つのデプロイメントを取得します。
GET	/api/deployments	デプロイメントのリストを取得します。クエリーパラメータを使用して、特定のプロジェクト、フォルダー、日付範囲などで結果を絞り込むことができます。

---

コネクション

タイプ	リソース	説明
GET	/api/connections	ユーザーに属しているコネクションを列挙します。

---

ジョブ

タイプ	リソース	説明
GET	/api/recipes/:recipe_id/jobs	レシピに属しているジョブを列挙します。
GET	/api/recipes/:recipe_id/jobs/id_mappings	レシピに属しているジョブ ID のマッピングを列挙します。

---

レシピ

タイプ	リソース	説明
GET	/api/recipes/:id	レシピの詳細を取得します。
POST	/api/recipes	レシピを作成します。
POST	/api/recipes/:id/copy	レシピをコピーします。
PUT	/api/recipes/:id	レシピを更新します。
GET	/api/recipes	ユーザーに属しているレシピを列挙します。
PUT	/api/recipes/:id/start	レシピを開始します。
PUT	/api/recipes/:id/stop	レシピを停止します。
DELETE	/api/recipes/:id	レシピを削除します。

---

ユーザー

タイプ	リソース	説明
GET	/api/users/me	認証されたユーザーの詳細を取得します。

---

レシピのライフサイクル管理

タイプ	リソース	説明
POST	/api/packages/export/:manifest_id	マニフェストに基づいてパッケージをエクスポートします。
POST	/api/packages/import/:folder_id	パッケージをフォルダーにインポートします。
GET	/api/packages/:id	ID に基づいてパッケージを取得します。
GET	/api/packages/:id/download	パッケージをダウンロードします。

---

API プラットフォーム

タイプ	リソース	説明
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 クライアントを列挙します。
POST	/api/api_clients	API クライアントを作成します。
GET	/api/api_access_profiles	API クライアントに属しているアクセスプロファイルを列挙します。
POST	/api/api_access_profiles	API クライアントに属しているアクセスプロファイルを作成します。
PUT	/api/api_access_profiles	API クライアントに属しているアクセスプロファイルを更新します。
PUT	/api_access_profiles/:api_access_profile_id/enable	API クライアントに属しているアクセスプロファイルを有効にします。
PUT	/api_access_profiles/:api_access_profile_id/disable	API クライアントに属しているアクセスプロファイルを無効にします。
PUT	/api/api_access_profiles/:id/refresh_secret	アクセスプロファイルのトークンまたはシークレットを更新します。

---

ロール

タイプ	リソース	説明
GET	/api/roles	カスタムロールを列挙します。
POST	/api/roles/:role_id/copy	カスタムロールのコピーを作成します。

---

環境プロパティ

タイプ	リソース	説明
GET	/api/properties	接頭辞と一致する環境プロパティを列挙します。
POST	/api/properties	環境プロパティをアップサートします。

---

Lookup table

タイプ	リソース	説明
GET	/api/lookup_tables	テーブルを列挙します。
GET	/api/lookup_tables/:lookup_table_id/lookup	行を検索します。
GET	/api/lookup_tables/:lookup_table_id/rows	行を列挙します。
POST	/api/lookup_tables/:lookup_table_id/rows	行を追加します。
PUT	/api/lookup_tables/:lookup_table_id/rows/:row_id	行を更新します。
DELETE	/api/lookup_tables/:lookup_table_id/rows/:row_id	行を削除します。
GET	/api/lookup_tables/:lookup_table_id/rows/:row_id	行を取得します。