Onderzoeks-API

Beheer onderzoeken binnen mindzieStudio-projecten. Onderzoeken zijn de primaire containers voor procesmininganalyse, waarbij datasets gekoppeld worden aan notitieboeken die analytische workflows definiëren.

Functies

Beheer van Onderzoeken

Maak onderzoeken aan, haal ze op, werk ze bij en verwijder ze. Lijst alle onderzoeken in een project met ondersteuning voor paginering.

Bekijk Beheer-API

Toegang tot Notitieboeken

Haal notitieboeken binnen een onderzoek op, inclusief het hoofdnotitieboek dat automatisch wordt aangemaakt bij elk onderzoek.

Bekijk Notitieboeken-API

Beschikbare Endpoints

Connectiviteitstesten

Methode Endpoint Beschrijving
GET /api/{tenantId}/{projectId}/investigation/unauthorized-ping Openbare connectiviteitstest
GET /api/{tenantId}/{projectId}/investigation/ping Geauthentiseerde connectiviteitstest

Onderzoek CRUD

Methode Endpoint Beschrijving
GET /api/{tenantId}/{projectId}/investigation Lijst alle onderzoeken
GET /api/{tenantId}/{projectId}/investigation/{investigationId} Haal details van een onderzoek op
POST /api/{tenantId}/{projectId}/investigation Maak een onderzoek aan
PUT /api/{tenantId}/{projectId}/investigation/{investigationId} Werk een onderzoek bij
DELETE /api/{tenantId}/{projectId}/investigation/{investigationId} Verwijder een onderzoek

Toegang tot Notitieboeken

Methode Endpoint Beschrijving
GET /api/{tenantId}/{projectId}/investigation/{investigationId}/notebooks Lijst alle notitieboeken
GET /api/{tenantId}/{projectId}/investigation/{investigationId}/main-notebook Haal het hoofdnotitieboek op

Authenticatie

Alle Investigation API-endpoints vereisen een geldige Tenant API-key. Voeg de API-key toe in de Authorization-header.

Zie Authenticatie voor details over API-keytypen en gebruik.

Snel Beginnen

# Lijst alle onderzoeken in een project
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/investigation" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Maak een nieuw onderzoek aan
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"}'

Belangrijke Opmerkingen

  • Dataset Vereist: Elk onderzoek moet gekoppeld zijn aan een bestaande dataset
  • Hoofdnotitieboek: Er wordt automatisch een hoofdnotitieboek aangemaakt bij het creëren van een onderzoek
  • Cache Vereist: Laad het project in de cache voordat je notitieboeken opent via het notebooks-endpoint
  • CASCADE Verwijdering: Het verwijderen van een onderzoek verwijdert permanent alle notitieboeken en analysegeschiedenis ervan
  • Operation Center: Stel isUsedForOperationCenter in op true voor onderzoeken die gebruikt worden in realtime monitoring