POST /events

Contents[Hide]

Genera un evento de tipo API en CNM.


POST /events.json Genera un evento.

 

El dispositivo al que se asocia el evento será:

  • El especificado por los parámetros devicename y devicedomain

  • El especificado por el parámetro deviceip

  • El especificado por deviceid

  • Si en la llamada no se especifica ninguno de los parámetros anteriores, el evento se asociará a la dirección IP desde la que se invoca al endpoint.

 

1. Parámetros

 

 

NombreDescripción
devicename Nombre del dispositivo dentro de CNM
devicedomain Dominio del dispositivo
deviceip Dirección ip del dispositivo
deviceid Identificador del dispositivo dentro de CNM
msg Mensaje del evento. Es un texto especificado por el usuario que se almacena en el campo MSG de los eventos recibidos como texto plano.
key Identificador del tipo de evento. Permite al usuario definir y categorizar sus propios eventos. No obstante es opcional y si el usuario no lo especifica, el sistema generará un valor a partir de los datos recibidos.
campos de usuario Al margen del parámetro msg, el usuario puede definir sus propios parámetros. Estos datos se almacenarán en formato JSON en el campo MSG de los eventos recibidos y permiten definir condiciones de alerta sobre los mismos.

 


2. Códigos de respuesta

 

CódigoDescripción
200 Resultado correcto
400 Error en la petición.
401 Error de autenticación.
403 Error por falta de permisos.
500 Error interno del servidor

 

3. Valor devuelto

Devuelve un vector de datos indicando el identificador del evento creado.

4. Ejemplos

 

root@cnm-devel2:/var/www/html/onm/api/inc# curl -ki -H "Authorization: 15e2289172012a8f6009d3de6b395ac1" -X POST "https://localhost/onm/api/1.0/events.json" -F "deviceid=1" -F "msg=TEST" -F "evkey=0001"

 

HTTP/1.1 100 Continue

HTTP/1.1 200 OK
Date: Mon, 03 Mar 2014 14:11:39 GMT
Server: Apache/2.2.16 (Debian) PHP/5.3.3-7 with Suhosin-Patch proxy_html/3.0.1 mod_ssl/2.2.16 OpenSSL/0.9.8o mod_perl/2.0.4 Perl/v5.10.1
X-Powered-By: PHP/5.3.3-7
Expires: Thu, 19 Nov 1981 08:52:00 GMT
Cache-Control: no-store, no-cache, must-revalidate, post-check=0, pre-check=0
Pragma: no-cache
:
Vary: Accept-Encoding
Content-Length: 65
Content-Type: text/html; charset=utf-8

{"rc":0,"rcstr":"Event successfully created","eventid":"1903905"}

 

 

 

 

Más en esta categoría: « GET /devices PUT /devices »

Iniciar sesión

Back to Top