Investigation API

Manage investigations within mindzieStudio projects. Investigations are the primary containers for process mining analysis, linking datasets to notebooks that define analytical workflows.

Features

Investigation Management

Create, retrieve, update, and delete investigations. List all investigations in a project with pagination support.

View Management API

Notebook Access

Retrieve notebooks within an investigation, including the main notebook that is automatically created with each investigation.

View Notebooks API

Available Endpoints

Connectivity Testing

Method	Endpoint	Description
GET	`/api/{tenantId}/{projectId}/investigation/unauthorized-ping`	Public connectivity test
GET	`/api/{tenantId}/{projectId}/investigation/ping`	Authenticated connectivity test

Investigation CRUD

Method	Endpoint	Description
GET	`/api/{tenantId}/{projectId}/investigation`	List all investigations
GET	`/api/{tenantId}/{projectId}/investigation/{investigationId}`	Get investigation details
POST	`/api/{tenantId}/{projectId}/investigation`	Create an investigation
PUT	`/api/{tenantId}/{projectId}/investigation/{investigationId}`	Update an investigation
DELETE	`/api/{tenantId}/{projectId}/investigation/{investigationId}`	Delete an investigation

Notebook Access

Method	Endpoint	Description
GET	`/api/{tenantId}/{projectId}/investigation/{investigationId}/notebooks`	List all notebooks
GET	`/api/{tenantId}/{projectId}/investigation/{investigationId}/main-notebook`	Get main notebook

Authentication

All Investigation API endpoints require a valid Tenant API key. Include the API key in the Authorization header.

See Authentication for details on API key types and usage.

Quick Start

# List all investigations in a project
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/investigation" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Create a new investigation
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"}'

Important Notes

Dataset Required: Every investigation must be linked to an existing dataset
Main Notebook: A main notebook is automatically created when an investigation is created
Cache Required: Load the project into cache before accessing notebooks via the notebooks endpoint
CASCADE Delete: Deleting an investigation permanently removes all its notebooks and analysis history
Operation Center: Set isUsedForOperationCenter to true for investigations used in real-time monitoring