Rest API de Eventos

El Rest API de Eventos permite a los clientes modificar y gestionar de forma masiva la creación, edición y eliminación de eventos. Esto permite al cliente crear procesos de sincronización de datos, logrando así que los datos Eventos de BPulse reflejen la realidad del negocio al administrar sus eventos.

Tabla de contenido

 

Seguridad

Todos las APIs aquí mencionadas se autentican usando en

Headers

  • AuthorizationBasic {user:pass}
  • Content-Typeapplication/json

{user:pass}: Es el uso del hash generado en base 64 de los datos.

Definición de estructura

Base de respuesta BPulse

JSON Response base BPulse
1
2
3
4
5
6
{
    "errorCode": "string",
    "error": "string",
    "domain": "object",
    "attErrors": "string"
}

Descripción

Atributo
Tipo
Descripción
errorCode string Retorna el código del error que ha ocurrido, en caso de ser exitoso el campo es nulo.
error string Retorna el mensaje del error que ha ocurrido, en caso de ser exitoso el campo es nulo.
domain object Retorna el objeto que se consulta en caso de ser exitoso contendrá un objeto de Event de presentar error vendrá la excepción.
attErrors string Retorna atributos complementarios del mensaje que ha ocurrido como su origen, en caso de ser exitoso el campo es nulo.

Objeto de eventos

JSON Event
1
2
3
4
5
6
7
8
9
10
{
    "id": "string",
    "title": "string",
    "description": "string",
    "type": "string",
    "source": "string",
    "datasource": "string",
    "startdate": "long",
    "enddate": "long"
}

Descripción

Atributo
Tipo
Descripción
id string Identificador del evento generado por BPulse.
title string Campo obligatorio que indica un título al evento.
description string Campo obligatorio que indica una descripción acerca del evento ocurrido.
type string Campo obligatorio donde se selecciona el tipo del evento, en donde los únicos valores posibles son INFO, NEWS, WARN ó ERROR.
source string Opcional, fuente del origen del evento que puede ser un Id_Servidor, Id_Proc_Batch, etc.
datasource string Opcional, fuente de datos existente en BPulse que se ha podido afectar por el evento ocurrido.
startdate long Campo obligatorio donde se indica la fecha y hora de inicio del evento en Timestamp.
enddate long Campo obligatorio donde se indica la fecha y hora de finalización del evento en Timestamp.

 

Definición de Rest API

GET

  • http://<your-server-ip>/app.model/api/model/events/{from}/{to}

HTTP/1.1
Content-Type: application/json

Permite realizar consultas de eventos por un rango de tiempo consultado y retorna una lista de registros para el rango de fecha indicado.

 

Parámetros

Nombre
En
Tipo
Descripción
from path long Fecha inicio a consultar en timestamp
to path long Fecha final a consultar en timestamp

 

Responses

Nombre
Tipo
Descripción
200 Response Respuesta exitosa

 

HTTP/1.1 200 OK
Content-Type: application/json

JSON Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
    "errorCode": "string",
    "error": "string",
    "domain": [
        {
            "id": "string",
            "title": "string",
            "description": "string",
            "type": "string",
            "source": "string",
            "datasource": "string",
            "startdate": "long",
            "enddate": "long"
        }
    ],
    "attErrors": "string"
}

 

  • http://<your-server-ip>/app.model/api/model/events/{eventId}

HTTP/1.1
Content-Type: application/json

Permite realizar consultas de eventos por el Id indicado.

 

Parámetros

Nombre
En
Tipo
Descripción
eventId path string Event ID

 

Responses

Nombre
Tipo
Descripción
200 Response Respuesta exitosa

HTTP/1.1 200 OK
Content-Type: application/json

JSON Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "errorCode": "string",
    "error": "string",
    "domain": {
        "id": "string",
        "title": "string",
        "description": "string",
        "type": "string",
        "source": "string",
        "datasource": "string",
        "startdate": "long",
        "enddate": "long"
    },
    "attErrors": "string"
}

POST

  • http://<your-server-ip>/app.model/api/model/events/

HTTP/1.1
Content-Type: application/json

Crea un nuevo registro y retorna el id del evento creado en el.

 

Parámetros

Nombre
En
Tipo
Descripción
body body Event Objeto del evento que será almacenado.
JSON Body
1
2
3
4
5
6
7
8
9
10
{
    "id": "string",
    "title": "string",
    "description": "string",
    "type": "string",
    "source": "string",
    "datasource": "string",
    "startdate": "long",
    "enddate": "long"
}

 

Responses

Nombre
Tipo
Descripción
200 Response Respuesta exitosa

HTTP/1.1 200 OK
Content-Type: application/json

JSON Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "errorCode": "string",
    "error": "string",
    "domain": {
        "id": "string",
        "title": "string",
        "description": "string",
        "type": "string",
        "source": "string",
        "datasource": "string",
        "startdate": "long",
        "enddate": "long"
    },
    "attErrors": "string"
}

PUT

  • http://<your-server-ip>/app.model/api/model/events/{eventId}

HTTP/1.1
Content-Type: application/json

Permite realizar la edición o actualización de un evento a través del Id indicado.

 

Parámetros

Nombre
En
Tipo
Descripción
eventId path string Event ID
body body Event Objeto del evento que será almacenado.
JSON Body
1
2
3
4
5
6
7
8
9
10
{
    "id": "string",
    "title": "string",
    "description": "string",
    "type": "string",
    "source": "string",
    "datasource": "string",
    "startdate": "long",
    "enddate": "long"
}

 

Responses

Nombre
Tipo
Descripción
200 Response Respuesta exitosa

HTTP/1.1 200 OK
Content-Type: application/json

JSON Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "errorCode": "string",
    "error": "string",
    "domain": {
        "id": "string",
        "title": "string",
        "description": "string",
        "type": "string",
        "source": "string",
        "datasource": "string",
        "startdate": "long",
        "enddate": "long"
    },
    "attErrors": "string"
}

DELETE

  • http://<your-server-ip>/app.model/api/model/events/{eventId}

HTTP/1.1
Content-Type: application/json

Permite realizar la eliminación de un evento a través del Id indicado.

 

Parámetros

Nombre
En
Tipo
Descripción
eventId path string Event ID
body body Event Objeto del evento que será almacenado.
JSON Body
1
2
3
4
5
6
7
8
9
10
{
    "id": "string",
    "title": "string",
    "description": "string",
    "type": "string",
    "source": "string",
    "datasource": "string",
    "startdate": "long",
    "enddate": "long"
}

 

Responses

Nombre
Tipo
Descripción
200 Response Respuesta exitosa

HTTP/1.1 200 OK
Content-Type: application/json

JSON Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
    "errorCode": "string",
    "error": "string",
    "domain": {
        "id": "string",
        "title": "string",
        "description": "string",
        "type": "string",
        "source": "string",
        "datasource": "string",
        "startdate": "long",
        "enddate": "long"
    },
    "attErrors": "string"
}