EventLog API

El API de eventLog es un servicio REST que permite operaciones de CRUD sobre el objeto EventLog compuesto por los siguientes atributos:

 

Atributo
Tipo
Descripción
id String El identificador del registro debe cumplir con el estandar : appId_clientId_uuid

appId : bpulse

clientId : El id de cliente en bpulse

uuid : identificador único

type String Los tipos de eventos que se pueden representar son:

WARN | ERROR | INFO | NEWS

title String Titulo representativo para el evento (máx 30 Caracteres)
description String Descripción del evento
startDate long Fecha de inicio del evento

ej: 1446577796000 -> representa 2015-11-03 19:09:56

endDate long Fecha de fin del evento

ej: 1446577796000 -> representa 2015-11-03 19:09:56

NOTA: Si startDate < endDate El evento se visualiza como un evento que transcurre continuamente entre estas dos fechas

source String Permite agrupar eventos, valores permitidos : GENERAL | SOURCE

GENERAL : Muestra el evento en un solo grupo

SOURCE : Permite agrupar eventos por cada uno de los datasource definidos en la aplicación

dataSourceId String (opcional) Identificador del datasource que puede ser usado si el atributo source==SOURCE

ej: appId_clientId_datasourceName

appId : bpulse

clientId : El id de cliente en bpulse

uuid : nombre de uno de los datasource definidos en la aplicación

 

NOTA: Si el atributo source es source==GENERAL

Poner dataSourceId=”*”

editable String Debe enviarse el valor “N”
version String atributo auto generado para controlar que se actualice el registro actual de base de datos.

NOTA: No es requerida para la creación

Para visualizar los eventos creados ir a la url : http://<your-server-ip>/app.web/eventLog.html

La urls disponibles:

Para todas las urls usar los siguientes headers.

Headers

  •  Authorization: Basic user:pass
  • Content-Type: application/json
  • URL Create:

Method: POST

http://<your-server-ip>/app.web/rest/admin/eventLog

Body
//Ejemplo del body
{
    "id": "bpulse_clientex_14465676813306546",
    "type": "WARN",
    "title": "Evento 1",
    "description": "Descripcion del evento WARN ",
    "startDate": 1446567600000,
    "endDate": 1446567600000,
    "source": "GENERAL",
    "dataSourceId": "*",
    "editable": "N"
}
  • URL Update:

Method: PUT

http:/<your-server-ip>/app.web/rest/admin/eventLog

Body
 //Ejemplo del body
{
    "id": "bpulse_clientex_14465676813306546",
    "type": "WARN",
    "title": "Evento 1",
    "description": "Descripción del evento WARN edited",
    "startDate": 1446567600000,
    "endDate": 1446567600000,
    "source": "GENERAL",
    "dataSourceId": "*",
    "editable": "N",
    "version": "64b8301c-f37c-450e-b4ea-909afa0bdf96"  //Es importante que la versión esté actualizada con respecto a base de datos
}

URL Delete:

Method: DELETE

http:/<your-server-ip>/app.web/rest/admin/eventLog/{eventId}/{version}

Ej: http:/<your-server-ip>/app.web/rest/admin/eventLog/bpulse_clientex_14465676813306546/64b8301c-f37c-450e-b4ea-909afa0bdf96

En este caso el clientex tiene un evento con el id=bpulse_clientex_14465676813306546 y version=64b8301c-f37c-450e-b4ea-909afa0bdf96

URL Get:

Method : GET

http:/<your-server-ip>/app.web/rest/admin/eventLog/{eventId}

Ej:  http:/<your-server-ip>/app.web/rest/admin/eventLog/bpulse_clientex_14465676813306546

 

URL Get Events In Range:

Method : GET

http:/<your-server-ip>/app.web/rest/admin/eventLogsInRange?startDate=1446565600000&endDate=1446577796000

En el anterior caso se consultan los eventos que estén entre 2015-11-03 15:46:40 y 2015-11-03 19:09:56

 

URL Get Events Near

Method : GET

http:/<your-server-ip>/app.web/rest/admin/eventsNear?eventId=bpulse_clientex_14465676813306546

En el anterior caso se consulta el evento con id=bpulse_clientex_14465676813306546 y adicionalmente se traen los eventos cercanos a la fecha inicio -/+ 1dia