Investigation API

Verwalten Sie Untersuchungen innerhalb von mindzieStudio-Projekten. Untersuchungen sind die primären Container für Process-Mining-Analysen und verknüpfen Datensätze mit Notebooks, die analytische Workflows definieren.

Funktionen

Untersuchungsverwaltung

Erstellen, abrufen, aktualisieren und löschen Sie Untersuchungen. Listen Sie alle Untersuchungen in einem Projekt mit Unterstützung für Paginierung auf.

Management-API anzeigen

Zugriff auf Notebooks

Rufen Sie Notebooks innerhalb einer Untersuchung ab, einschließlich des Hauptnotebooks, das automatisch mit jeder Untersuchung erstellt wird.

Notebooks-API anzeigen

Verfügbare Endpunkte

Verbindungstest

Methode	Endpunkt	Beschreibung
GET	`/api/{tenantId}/{projectId}/investigation/unauthorized-ping`	Öffentlicher Verbindungstest
GET	`/api/{tenantId}/{projectId}/investigation/ping`	Authentifizierter Verbindungstest

Investigation CRUD

Methode	Endpunkt	Beschreibung
GET	`/api/{tenantId}/{projectId}/investigation`	Alle Untersuchungen auflisten
GET	`/api/{tenantId}/{projectId}/investigation/{investigationId}`	Details zur Untersuchung abrufen
POST	`/api/{tenantId}/{projectId}/investigation`	Eine Untersuchung erstellen
PUT	`/api/{tenantId}/{projectId}/investigation/{investigationId}`	Eine Untersuchung aktualisieren
DELETE	`/api/{tenantId}/{projectId}/investigation/{investigationId}`	Eine Untersuchung löschen

Zugriff auf Notebooks

Methode	Endpunkt	Beschreibung
GET	`/api/{tenantId}/{projectId}/investigation/{investigationId}/notebooks`	Alle Notebooks auflisten
GET	`/api/{tenantId}/{projectId}/investigation/{investigationId}/main-notebook`	Hauptnotebook abrufen

Authentifizierung

Alle Investigation-API-Endpunkte erfordern einen gültigen Tenant-API-Schlüssel. Fügen Sie den API-Schlüssel im Authorization-Header hinzu.

Siehe Authentifizierung für Details zu API-Schlüsseltypen und deren Verwendung.

Schnellstart

# Alle Untersuchungen in einem Projekt auflisten
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/investigation" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Eine neue Untersuchung erstellen
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"}'

Wichtige Hinweise

Datensatz erforderlich: Jede Untersuchung muss mit einem vorhandenen Datensatz verknüpft sein
Hauptnotebook: Ein Hauptnotebook wird automatisch erstellt, wenn eine Untersuchung angelegt wird
Cache erforderlich: Laden Sie das Projekt in den Cache, bevor Sie über den Notebooks-Endpunkt auf Notebooks zugreifen
Kaskadenlöschung: Das Löschen einer Untersuchung entfernt dauerhaft alle zugehörigen Notebooks und die Analysehistorie
Operation Center: Setzen Sie isUsedForOperationCenter auf true für Untersuchungen, die in der Echtzeitüberwachung verwendet werden