Projekt-API
Verwalten Sie Projekte innerhalb von mindzieStudio-Mandanten. Projekte sind die obersten Container für Datensätze, Untersuchungen, Dashboards und Analyse-Workflows.
Funktionen
Projektverwaltung
Erstellen, abrufen, aktualisieren und löschen Sie Projekte. Listen Sie alle Projekte in einem Mandanten mit Unterstützung für Paginierung auf.
Cache-Operationen
Laden Sie Projekte in den Speicher für einen schnellen Zugriff während API-Operationen. Essenziell für die effiziente Ausführung von Notebooks und Blöcken.
Benutzerberechtigungen
Verwalten Sie den Benutzerzugang zu Projekten. Fügen Sie Benutzer hinzu, aktualisieren Sie Berechtigungsstufen (Eigentümer vs Mitglied) und entfernen Sie Zugriffe.
Import & Export
Exportieren Sie Projekte als portable .mpz-Dateien zur Sicherung oder Übertragung. Importieren Sie Projekte aus .mpz-Dateien. Verwalten Sie Projekt-Thumbnails.
Import- und Export-API anzeigen
Verfügbare Endpunkte
Verbindungstest
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /api/{tenantId}/project/unauthorized-ping |
Öffentlicher Verbindungstest |
| GET | /api/{tenantId}/project/ping |
Authentifizierter Verbindungstest |
Projekt-CRUD
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /api/{tenantId}/project |
Alle Projekte auflisten |
| GET | /api/{tenantId}/project/{projectId} |
Projektdetails abrufen |
| POST | /api/{tenantId}/project |
Projekt erstellen |
| PUT | /api/{tenantId}/project/{projectId} |
Projekt aktualisieren |
| DELETE | /api/{tenantId}/project/{projectId} |
Projekt löschen |
| GET | /api/{tenantId}/project/{projectId}/summary |
Projektstatistiken abrufen |
Cache-Verwaltung
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/load |
Projekt in Cache laden |
| DELETE | /api/{tenantId}/project/{projectId}/unload |
Projekt aus Cache entladen |
Benutzerberechtigungen
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/users |
Projektbenutzer auflisten |
| POST | /api/{tenantId}/project/{projectId}/users/{userId} |
Benutzer zum Projekt hinzufügen |
| PUT | /api/{tenantId}/project/{projectId}/users/{userId} |
Benutzerberechtigung aktualisieren |
| DELETE | /api/{tenantId}/project/{projectId}/users/{userId} |
Benutzer entfernen |
Import/Export
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/download |
Als .mpz exportieren |
| POST | /api/{tenantId}/project/import |
Aus .mpz importieren |
Thumbnails
| Methode | Endpunkt | Beschreibung |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/thumbnail |
Thumbnail abrufen |
| POST | /api/{tenantId}/project/{projectId}/thumbnail |
Thumbnail aktualisieren |
| DELETE | /api/{tenantId}/project/{projectId}/thumbnail |
Thumbnail entfernen |
Authentifizierung
Alle Project-API-Endpunkte erfordern einen gültigen API-Schlüssel. Verwenden Sie mandantenbezogene API-Schlüssel für Projektoperationen.
Siehe Authentifizierung für Details zu API-Schlüsseltypen und deren Verwendung.
Schnellstart
# Alle Projekte in einem Mandanten auflisten
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project" \
-H "Authorization: Bearer YOUR_API_KEY"
# Projekt in den Cache laden, bevor Notebooks ausgeführt werden
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project/{projectId}/load" \
-H "Authorization: Bearer YOUR_API_KEY"
Wichtige Hinweise
- CASCADE-Löschung: Das Löschen eines Projekts entfernt dauerhaft alle Datensätze, Untersuchungen, Dashboards und Dateien
- Cache erforderlich: Laden Sie Projekte in den Cache, bevor Sie Notebooks oder Blöcke ausführen
- Cache-Dauer: Projekte bleiben 30 Minuten nach dem letzten Zugriff im Cache
- Vor dem Löschen exportieren: Exportieren Sie Projekte immer vor dem Löschen als Sicherung