Obtener Regla
Referencia API
Obtener Regla
Recuperar detalles de una regla específica por ID — en el motor de reglas gu1 para compliance y detección de riesgo, con ejemplos para get.
GET
Obtener Regla
Descripción General
Recupera información completa sobre una regla específica, incluyendo sus condiciones, acciones, estadísticas de ejecución e historial de versiones.Endpoint
Autenticación
Requiere una clave API válida en el encabezado de Authorization:Parámetros de Ruta
UUID de la regla a recuperar
Respuesta
UUID de la regla
ID de su organización
Nombre de la regla
Descripción de la regla
Categoría de la regla (kyc, kyb, aml, fraud, compliance, custom)
Estado actual (draft, active, shadow, archived, inactive)
Si la regla está habilitada
Prioridad de la regla (1-100)
Puntaje de riesgo asignado cuando la regla coincide
Estructura de condiciones completa con lógica anidada
Representación en cadena JSON de condiciones (para almacenamiento)
Array de acciones a ejecutar cuando la regla coincide
Configuración de alcance de la regla (países, tipos de entidad, ventanas temporales)
Array de tipos de entidad a los que se aplica la regla
Modo de evaluación (sync o async)
UUID de matriz de riesgo asociada (si existe)
Número de versión actual
UUID de la versión anterior (si existe)
Array de etiquetas para organización
Estadísticas de ejecución (ejecuciones, éxitos, fallos)
ID del usuario que creó la regla
Marca de tiempo ISO de creación
ID del usuario que actualizó la regla por última vez
Marca de tiempo ISO de última actualización
Ejemplos de Solicitudes
Ejemplo de Respuesta
Respuestas de Error
404 Not Found
401 Unauthorized
403 Forbidden
Casos de Uso
Mostrar Detalles de Regla en UI
Monitorear Rendimiento de Regla
Clonar Configuración de Regla
Exportar Configuración de Regla
Mejores Prácticas
- Cache de Datos de Regla: Cachear reglas accedidas frecuentemente para reducir llamadas API
- Monitorear Estadísticas: Revisar regularmente el objeto
statspara insights de rendimiento - Rastrear Versiones: Usar
versionypreviousVersionIdpara pistas de auditoría - Verificar Estado: Siempre verificar
enabledystatusantes de la ejecución - Usar Etiquetas: Aprovechar etiquetas para organización y filtrado
Ver También
- Listar Reglas - Consultar y filtrar reglas
- Actualizar Regla - Modificar configuración de regla
- Ejecutar Regla - Probar regla contra entidades
- Crear Regla - Crear nuevas reglas