Cómo obtener una lista de eventos usando la API REST
Esta guía explica cómo obtener una lista de eventos utilizando la API REST.
Requisitos
- Lea cómo habilitar la API REST
- Lea cómo generar el token de la API REST
- Lea cómo obtener el userID de un usuario
Recurso utilizado
Eventos > Reglas de eventos
Este es el primer recurso que utilizaremos. Necesitamos recopilar una lista de EventRuleIds para usar más adelante con el siguiente recurso Eventos.
Cómo hacerlo
Comenzamos utilizando el recurso reglas de eventos (2) para obtener los ID de las reglas de eventos:
1. Inicie sesión en http://nombre_del_host/comGpsGate/api/v.1/test
Nota: reemplace nombre_del_host con la dirección IP de su servidor o el nombre del host.
2. Haga clic en el nombre del recurso, luego > Probar
3. Inserte los parámetros requeridos. Este recurso de API requiere ID de la aplicación y fecha, userID, Desde, Hasta y Filtro. Luego presione Ejecutar.
Nota: Si no conoce su ID de aplicación, puede obtenerlo como se explica aquí.
4. En la respuesta debería recibir una lista de las reglas de eventos disponibles en la aplicación seleccionada con sus respectivos ID.
5. Ahora que conocemos los eventIDs, podemos usarlos en nuestra próxima consulta utilizando el recurso eventos (1)
6. Ingresamos los parámetros solicitados por este recurso
Ejemplo: queremos listar todos los eventos de exceso de velocidad. Los eventos de exceso de velocidad tienen el ID 206 en nuestra captura de pantalla anterior.
7. La respuesta nos dará todos los eventos desde esa fecha para la unidad seleccionada de la fecha especificada. Cada repetición en la estructura de la respuesta es un evento diferente.
Rendimiento y Paginación
Para mejorar el rendimiento y tener mejor escalabilidad, hay un límite de 1000 registros en la respuesta de una solicitud HTTP GET. Este número puede disminuirse enviando parámetros de PageSize en la cadena de consulta de su solicitud, sin embargo, no puede exceder los 1000. Si hay más registros que el número especificado en el parámetro PageSize (o 1000 por defecto), se envía un enlace a la siguiente página junto con la respuesta en el encabezado x-pagination. Aquí hay un ejemplo de un encabezado x-pagination para una solicitud donde el PageSize especificado era 100.
x-pagination: {
|