API de Investigación

Gestiona investigaciones dentro de proyectos de mindzieStudio. Las investigaciones son los contenedores principales para el análisis de minería de procesos, vinculando conjuntos de datos a notebooks que definen flujos de trabajo analíticos.

Características

Gestión de Investigaciones

Crear, obtener, actualizar y eliminar investigaciones. Listar todas las investigaciones en un proyecto con soporte de paginación.

Ver API de Gestión

Acceso a Notebooks

Obtener notebooks dentro de una investigación, incluyendo el notebook principal que se crea automáticamente con cada investigación.

Ver API de Notebooks

Endpoints Disponibles

Pruebas de Conectividad

Método Endpoint Descripción
GET /api/{tenantId}/{projectId}/investigation/unauthorized-ping Prueba de conectividad pública
GET /api/{tenantId}/{projectId}/investigation/ping Prueba de conectividad autenticada

CRUD de Investigaciones

Método Endpoint Descripción
GET /api/{tenantId}/{projectId}/investigation Listar todas las investigaciones
GET /api/{tenantId}/{projectId}/investigation/{investigationId} Obtener detalles de una investigación
POST /api/{tenantId}/{projectId}/investigation Crear una investigación
PUT /api/{tenantId}/{projectId}/investigation/{investigationId} Actualizar una investigación
DELETE /api/{tenantId}/{projectId}/investigation/{investigationId} Eliminar una investigación

Acceso a Notebooks

Método Endpoint Descripción
GET /api/{tenantId}/{projectId}/investigation/{investigationId}/notebooks Listar todos los notebooks
GET /api/{tenantId}/{projectId}/investigation/{investigationId}/main-notebook Obtener el notebook principal

Autenticación

Todos los endpoints de la API de Investigación requieren una clave API válida del Tenant. Incluye la clave API en el encabezado Authorization.

Consulta Autenticación para detalles sobre tipos y uso de claves API.

Inicio Rápido

# Listar todas las investigaciones en un proyecto
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/{projectId}/investigation" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Crear una nueva investigación
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"}'

Notas Importantes

  • Conjunto de Datos Requerido: Cada investigación debe estar vinculada a un conjunto de datos existente
  • Notebook Principal: Se crea automáticamente un notebook principal cuando se crea una investigación
  • Caché Requerido: Carga el proyecto en caché antes de acceder a los notebooks mediante el endpoint de notebooks
  • Eliminación en CASCADA: Eliminar una investigación elimina permanentemente todos sus notebooks e historial de análisis
  • Centro de Operaciones: Establece isUsedForOperationCenter en true para investigaciones utilizadas en monitoreo en tiempo real