プロジェクトAPI
mindzieStudioテナント内のプロジェクトを管理します。プロジェクトはデータセット、調査、ダッシュボード、分析ワークフローのトップレベルのコンテナです。
機能
プロジェクト管理
プロジェクトの作成、取得、更新、削除。ページネーション対応でテナント内の全プロジェクトを一覧表示。
キャッシュ操作
API操作時の高速アクセスのためにプロジェクトをメモリにロード。ノートブックやブロックを効率的に実行するために必須。
ユーザー権限管理
プロジェクトへのユーザーアクセスを管理。ユーザー追加、権限レベル（オーナー vs メンバー）更新、アクセス削除。
インポート＆エクスポート
バックアップや転送用にプロジェクトをポータブルな.mpzファイルとしてエクスポート。.mpzファイルからのインポートも可能。プロジェクトのサムネイル管理。
利用可能なエンドポイント
接続テスト
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/{tenantId}/project/unauthorized-ping |
公開接続テスト |
| GET | /api/{tenantId}/project/ping |
認証済み接続テスト |
プロジェクトCRUD
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/{tenantId}/project |
すべてのプロジェクトを一覧表示 |
| GET | /api/{tenantId}/project/{projectId} |
プロジェクトの詳細取得 |
| POST | /api/{tenantId}/project |
プロジェクト作成 |
| PUT | /api/{tenantId}/project/{projectId} |
プロジェクト更新 |
| DELETE | /api/{tenantId}/project/{projectId} |
プロジェクト削除 |
| GET | /api/{tenantId}/project/{projectId}/summary |
プロジェクト統計情報取得 |
キャッシュ管理
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/load |
プロジェクトをキャッシュにロード |
| DELETE | /api/{tenantId}/project/{projectId}/unload |
キャッシュからプロジェクトをアンロード |
ユーザー権限
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/users |
プロジェクトのユーザー一覧 |
| POST | /api/{tenantId}/project/{projectId}/users/{userId} |
プロジェクトにユーザー追加 |
| PUT | /api/{tenantId}/project/{projectId}/users/{userId} |
ユーザー権限更新 |
| DELETE | /api/{tenantId}/project/{projectId}/users/{userId} |
ユーザー削除 |
インポート/エクスポート
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/download |
.mpz形式でエクスポート |
| POST | /api/{tenantId}/project/import |
.mpzファイルからインポート |
サムネイル
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/thumbnail |
サムネイル取得 |
| POST | /api/{tenantId}/project/{projectId}/thumbnail |
サムネイル更新 |
| DELETE | /api/{tenantId}/project/{projectId}/thumbnail |
サムネイル削除 |
認証
すべてのProject APIエンドポイントは有効なAPIキーが必要です。プロジェクト操作にはテナントスコープのAPIキーを使用してください。
APIキーの種類と使用法の詳細は認証を参照してください。
クイックスタート
# テナント内の全プロジェクトを一覧表示
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project" \
-H "Authorization: Bearer YOUR_API_KEY"
# ノートブック実行前にプロジェクトをキャッシュにロード
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project/{projectId}/load" \
-H "Authorization: Bearer YOUR_API_KEY"
重要な注意事項
- カスケード削除: プロジェクト削除はすべてのデータセット、調査、ダッシュボード、ファイルを完全に削除します
- キャッシュ必須: ノートブックやブロックを実行する前に必ずプロジェクトをキャッシュにロードしてください
- キャッシュ期間: 最終アクセスから30分間プロジェクトはキャッシュに保持されます
- 削除前にエクスポートを: 削除前には必ずプロジェクトをバックアップとしてエクスポートしてください