API de Acciones

Ejecute y gestione acciones de flujo de trabajo de forma programática.

Descripción general

La API de Acciones proporciona endpoints para gestionar y ejecutar acciones de flujo de trabajo dentro de mindzieStudio. Las acciones son componentes automatizados del flujo de trabajo que pueden ejecutarse bajo demanda o programadamente.

Estructura de la URL base

Todos los endpoints de la API de Acción siguen este patrón:

/api/{tenantId}/{projectId}/action/...

Parámetros de ruta:

Parámetro Tipo Descripción
tenantId GUID Su identificador de tenant
projectId GUID Su identificador de proyecto

Endpoints disponibles

Monitoreo de estado

Pruebe la conectividad y valide la autenticación.

  • GET /api/{tenantId}/{projectId}/action/unauthorized-ping - Prueba básica de conectividad (no requiere autenticación)
  • GET /api/{tenantId}/{projectId}/action/ping - Prueba de conectividad autenticada

Ver documentación de Ping

Gestión de acciones

Liste y recupere detalles de acciones.

  • GET /api/{tenantId}/{projectId}/action - Listar todas las acciones de un proyecto
  • GET /api/{tenantId}/{projectId}/action/{actionId} - Obtener detalles de una acción específica

Ver documentación de Gestión de acciones

Ejecutar acciones

Dispare la ejecución de acciones programáticamente.

  • GET /api/{tenantId}/{projectId}/action/execute/{actionId} - Ejecutar una acción

Ver documentación de Ejecución

Autenticación

La mayoría de los endpoints requieren autenticación mediante token Bearer o clave API. La única excepción es el endpoint unauthorized-ping, que puede llamarse sin autenticación.

Ejemplo de solicitud autenticada:

GET https://your-mindzie-instance.com/api/{tenantId}/{projectId}/action/ping
Authorization: Bearer {your-access-token}

Casos de uso comunes

  • Monitoreo de estado: Utilice los endpoints de ping para verificar la conectividad y autenticación del API
  • Automatización: Ejecute acciones programáticamente como parte de pipelines ETL o trabajos programados
  • Integración: Active flujos de trabajo de mindzieStudio desde sistemas externos
  • Monitoreo: Liste e inspeccione acciones para seguir el estado del flujo de trabajo

Respuestas de error

Todos los endpoints devuelven códigos de estado HTTP estándar:

Estado Descripción
200 Éxito
401 No autorizado - autenticación inválida o ausente
404 No encontrado - la acción o recurso no existe

Comience

  1. Inicie con los Endpoints de Ping para probar la conectividad
  2. Use Gestión de Acciones para descubrir las acciones disponibles
  3. Ejecute Acciones para activar flujos de trabajo