API d'Investigation

Gérez les investigations au sein des projets mindzieStudio. Les investigations sont les conteneurs principaux pour l'analyse de process mining, reliant des ensembles de données à des notebooks qui définissent des workflows analytiques.

Fonctionnalités

Gestion des Investigations

Créez, récupérez, mettez à jour et supprimez des investigations. Listez toutes les investigations d'un projet avec prise en charge de la pagination.

Voir l'API de Gestion

Accès aux Notebooks

Récupérez les notebooks d'une investigation, y compris le notebook principal qui est automatiquement créé avec chaque investigation.

Voir l'API des Notebooks

Endpoints Disponibles

Test de Connectivité

Méthode Endpoint Description
GET /api/{tenantId}/{projectId}/investigation/unauthorized-ping Test de connectivité public
GET /api/{tenantId}/{projectId}/investigation/ping Test de connectivité authentifié

CRUD d'Investigation

Méthode Endpoint Description
GET /api/{tenantId}/{projectId}/investigation Lister toutes les investigations
GET /api/{tenantId}/{projectId}/investigation/{investigationId} Obtenir les détails d'une investigation
POST /api/{tenantId}/{projectId}/investigation Créer une investigation
PUT /api/{tenantId}/{projectId}/investigation/{investigationId} Mettre à jour une investigation
DELETE /api/{tenantId}/{projectId}/investigation/{investigationId} Supprimer une investigation

Accès aux Notebooks

Méthode Endpoint Description
GET /api/{tenantId}/{projectId}/investigation/{investigationId}/notebooks Lister tous les notebooks
GET /api/{tenantId}/{projectId}/investigation/{investigationId}/main-notebook Obtenir le notebook principal

Authentification

Tous les endpoints de l'API Investigation requièrent une clé API Tenant valide. Incluez la clé API dans l'en-tête Authorization.

Voir Authentification pour plus de détails sur les types et l'utilisation des clés API.

Démarrage Rapide

# Lister toutes les investigations d'un projet
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/investigation" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Créer une nouvelle 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"}'

Notes Importantes

  • Ensemble de données requis : Chaque investigation doit être liée à un ensemble de données existant
  • Notebook principal : Un notebook principal est automatiquement créé lors de la création d'une investigation
  • Cache requis : Chargez le projet dans le cache avant d'accéder aux notebooks via l'endpoint notebooks
  • Suppression en CASCADE : Supprimer une investigation supprime définitivement tous ses notebooks et l'historique d'analyse
  • Centre d'Opération : Affectez isUsedForOperationCenter à true pour les investigations utilisées en surveillance en temps réel