Referencia de API
API de Mantenimiento
Endpoints CRUD de planes, ejecucion, preview, notificaciones de prueba, pausa/reanudacion, contadores, historial, cumplimiento y optimizacion.
Endpoints de Planes
| Metodo | Endpoint | Descripcion |
|---|---|---|
GET | /api/v1/maintenance/plans | Listar planes |
POST | /api/v1/maintenance/plans | Crear plan |
GET | /api/v1/maintenance/plans/{plan_id} | Obtener plan |
PUT | /api/v1/maintenance/plans/{plan_id} | Actualizar plan |
DELETE | /api/v1/maintenance/plans/{plan_id} | Eliminar plan |
Ejecucion y Preview
| Metodo | Endpoint | Descripcion |
|---|---|---|
POST | /api/v1/maintenance/plans/{plan_id}/execute | Ejecutar plan manualmente |
GET | /api/v1/maintenance/plans/{plan_id}/preview | Preview de tarea a generar |
POST | /api/v1/maintenance/plans/{plan_id}/test-notification | Enviar notificacion de prueba |
Ejecutar Plan
Fuerza la ejecucion inmediata del plan, generando la tarea sin esperar al scheduler:
POST /api/v1/maintenance/plans/{plan_id}/executeRespuesta 200:
{
"task_id": "task_abc123",
"task_code": "MAN-042",
"next_due_at": "2026-04-24T10:00:00Z"
}Preview de Tarea
Muestra como seria la tarea generada sin ejecutar el plan:
GET /api/v1/maintenance/plans/{plan_id}/previewPausa y Reanudacion
| Metodo | Endpoint | Descripcion |
|---|---|---|
POST | /api/v1/maintenance/plans/{plan_id}/pause | Pausar plan |
POST | /api/v1/maintenance/plans/{plan_id}/resume | Reanudar plan |
Pausar un plan preserva la fecha
next_due_at. Al reanudar, se recalcula si la fecha ya paso.Contadores
Para planes con disparador por contador:
| Metodo | Endpoint | Descripcion |
|---|---|---|
POST | /api/v1/maintenance/plans/{plan_id}/counter | Actualizar contador |
GET | /api/v1/maintenance/plans/{plan_id}/counter/history | Historial de contador |
POST /api/v1/maintenance/plans/{plan_id}/counter
{
"value": 523,
"source": "gateway_001"
}Si el valor alcanza el umbral, el plan se ejecuta automaticamente.
Historial de Ejecucion
GET /api/v1/maintenance/plans/{plan_id}/history?skip=0&limit=20Cada entrada incluye:
| Campo | Descripcion |
|---|---|
execution_id | ID unico de ejecucion |
task_id | Tarea generada |
trigger | calendar o counter |
executed_at | Timestamp de ejecucion |
executed_by | system o user_id |
Cumplimiento
GET /api/v1/maintenance/compliance?start_date=2026-01-01&end_date=2026-03-31Retorna metricas de cumplimiento del mantenimiento preventivo:
| Metrica | Descripcion |
|---|---|
compliance_rate | % de planes ejecutados a tiempo |
overdue_count | Planes vencidos en el periodo |
on_time_count | Planes ejecutados dentro del plazo |
average_delay_hours | Retraso promedio en ejecuciones tardias |
Optimizacion
POST /api/v1/maintenance/plans/{plan_id}/optimizeEl motor de IA analiza el historial del plan y sugiere ajustes:
- Frecuencia optima basada en patrones de falla
- Redistribucion de carga de trabajo entre tecnicos
- Consolidacion de rutas multi-activo
- Ajuste de umbrales de contadores
Las sugerencias se presentan como borrador que el usuario aprueba antes de aplicar.