調査API
mindzieStudioプロジェクト内の調査を管理します。調査はプロセスマイニング分析の主要なコンテナであり、データセットと解析ワークフローを定義するノートブックを関連付けます。
機能
調査管理
調査の作成、取得、更新、削除を行います。プロジェクト内のすべての調査をページネーション対応で一覧表示します。
ノートブックアクセス
調査内のノートブックを取得します。各調査作成時に自動生成されるメインノートブックも含みます。
利用可能なエンドポイント
接続テスト
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/{tenantId}/{projectId}/investigation/unauthorized-ping |
公開接続テスト |
| GET | /api/{tenantId}/{projectId}/investigation/ping |
認証済み接続テスト |
調査CRUD
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/{tenantId}/{projectId}/investigation |
すべての調査を一覧表示 |
| GET | /api/{tenantId}/{projectId}/investigation/{investigationId} |
調査の詳細を取得 |
| POST | /api/{tenantId}/{projectId}/investigation |
調査を作成 |
| PUT | /api/{tenantId}/{projectId}/investigation/{investigationId} |
調査を更新 |
| DELETE | /api/{tenantId}/{projectId}/investigation/{investigationId} |
調査を削除 |
ノートブックアクセス
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/{tenantId}/{projectId}/investigation/{investigationId}/notebooks |
すべてのノートブックを一覧表示 |
| GET | /api/{tenantId}/{projectId}/investigation/{investigationId}/main-notebook |
メインノートブックを取得 |
認証
すべての調査APIエンドポイントは有効なテナントのAPIキーが必要です。AuthorizationヘッダーにAPIキーを含めてください。
APIキーの種類と使用法については認証を参照してください。
クイックスタート
# プロジェクト内のすべての調査を一覧表示
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/investigation" \
-H "Authorization: Bearer YOUR_API_KEY"
# 新しい調査を作成
curl -X POST "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/investigation" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"investigationName": "Order Analysis", "datasetId": "your-dataset-guid"}'
重要な注意事項
- データセット必須: すべての調査は既存のデータセットにリンクされている必要があります
- メインノートブック: 調査作成時にメインノートブックが自動的に作成されます
- キャッシュ必須: ノートブックエンドポイントでアクセスする前にプロジェクトをキャッシュにロードしてください
- カスケード削除: 調査を削除すると、そのすべてのノートブックと分析履歴も永久に削除されます
- オペレーションセンター: リアルタイム監視に使用する調査は
isUsedForOperationCenterをtrueに設定してください