Suscripción a eventos

Esta función permite suscribirse a eventos de Calibry. Cuando se produzca uno de estos eventos, se publicará a todos los suscriptores que haya de él, enviando la información correspondiente mediante una llamada HTTP/HTTPS con los datos en formato JSON.

Parámetros de Entrada

Parámetro

Tipo

Descripción

typeId CAMPO OBLIGATORIO

String

Indica el evento al que suscribirse. Los posibles valores son:

ItemCreation = Creación de Equipos

ItemUpdate = Actualización de Equipos

WorkOrderUpdate = Actualización de Órdenes de trabajo

BatchUpdate = Actualización de Lotes

Para ver más información sobre los tipos de eventos, consultar la página Tipos de Eventos.

description

String

Descripción de la suscripción

url CAMPO OBLIGATORIO

String

URL a la que se llamará cuando se produzca un evento del tipo typeId

Parámetros de Salida

Parámetro	Tipo	Descripción
typeId	String	Indica el tipo de evento de la suscripción
description	String	Descripción de la suscripción
url	String	URL a la que se llama cuando se produzca un evento del tipo typeId
subscriptionKey	String	Identificador de la suscripción. Este dato sirve para cancelar la suscripción

Códigos Error

Código	Descripción
1000	Error genérico
14000	Error en la lectura de los parámetros de entrada
14001	Faltan parámetros obligatorios
14002	La URL no es válida
14003	El tipo (typeId) no es válido

Ejemplos

Llamada (Método POST)

JSON

https://servidor:8443/calibry-rest-api/rest/cif/subscribe


Headers:
    Authorization
    Content-Type = application/json

Body:
{
    "typeId": "ItemCreation",
    "description": "Suscripción creación items para myCustomApp",
    "url": "http://myServer.com/myApp/rest/items"
}

Respuestas

Correcta:

JSON

{
    "typeId": "ItemCreation",
    "description": "Suscripción creación items para myCustomApp",
    "url": "http://myServer.com/myApp/rest/items"
    "subscriptionKey": "U2ugku49Zw7T6oU4KeQX9Dsg3ee04xxx"
}

Error:

JSON

{"code":"14001"}