Actions API
ワークフローアクションをプログラムで実行および管理します。
概要
Actions APIは、mindzieStudio内のワークフローアクションを管理および実行するためのエンドポイントを提供します。アクションはオンデマンドまたはスケジュールで実行可能な自動化されたワークフローの構成要素です。
ベースURL構造
すべてのAction APIエンドポイントは以下のパターンに従います：
/api/{tenantId}/{projectId}/action/...
パスパラメーター：
| パラメーター | 型 | 説明 |
|---|---|---|
tenantId |
GUID | テナント識別子 |
projectId |
GUID | プロジェクト識別子 |
利用可能なエンドポイント
ヘルスモニタリング
接続テストと認証の検証を行います。
- GET
/api/{tenantId}/{projectId}/action/unauthorized-ping- 基本的な接続テスト（認証不要） - GET
/api/{tenantId}/{projectId}/action/ping- 認証済みの接続テスト
アクション管理
アクションの一覧取得と詳細取得を行います。
- GET
/api/{tenantId}/{projectId}/action- プロジェクト内のすべてのアクションを一覧表示 - GET
/api/{tenantId}/{projectId}/action/{actionId}- 特定アクションの詳細を取得
アクション実行
アクションの実行をプログラムでトリガーします。
- GET
/api/{tenantId}/{projectId}/action/execute/{actionId}- アクションを実行
認証
ほとんどのエンドポイントはBearerトークンまたはAPIキーによる認証が必要です。認証不要な例外はunauthorized-pingエンドポイントのみです。
認証済みリクエストの例：
GET https://your-mindzie-instance.com/api/{tenantId}/{projectId}/action/ping
Authorization: Bearer {your-access-token}
主なユースケース
- ヘルスモニタリング： pingエンドポイントでAPIの接続性および認証を確認
- 自動化： ETLパイプラインやスケジュールジョブの一部としてプログラムでアクションを実行
- 統合： 外部システムからmindzieStudioワークフローをトリガー
- モニタリング： アクションの一覧と状態を確認しワークフローの状況を追跡
エラー応答
すべてのエンドポイントは標準のHTTPステータスコードを返します：
| ステータス | 説明 |
|---|---|
| 200 | 成功 |
| 401 | 未認証 - 認証情報が無効または不足 |
| 404 | 見つかりません - アクションまたはリソースが存在しない |
はじめに
- まずはPingエンドポイントで接続性をテスト
- アクション管理で利用可能なアクションを確認
- アクション実行でワークフローをトリガー