Registers

Descripción

Este endpoint muestra un conjunto de registros de los últimos trabajos de publicación hacia el servidor que acabaron con algún tipo de error.

El tamaño de este listado puede configurarse mediante la variable de entorno: CONFIG_CONFLICT_BUFFER_LENGTH, cuyo valor por defecto es 100.

No se recomienda modificación de la variable CONFIG_CONFLICT_BUFFER_LENGTH si no se posee un conocimiento profundo de la herramienta.

Podemos encontrarlo en la ruta <ip>:<mqtt_port>/v1/registers.

Visualización

Al realizarse una petición GET al endpoint nos devuelve la siguiente respuesta en formato JSON.

    {
        "id": "449ef8bc-be01-4ca3-af7a-2a8f588d4bc1",
        "createdAt": "2022-06-30T12:05:25.500Z",
        "resolvedAt": "2022-06-30T12:05:25.764Z",
        "quantity": 5,
        "hasErrors": true,
        "errors": [
            {
                "datapoint": "ProcessingError",
                "error": "Wrong list of datapoints, some datapoints are null. The drivers that commit this error was netin-ds-drv-s7"
            },
            {
                "datapoint": "TypeError",
                "error": "Cannot read property 'split' of null"
            }
        ],
        "entryId": "10.10.50.200:deviceInfo:1"
    }, 

Listado de campos

• id(string): Identificador único del proceso de publicación del trabajo

• type(ProcessType): Tipo de trabajo publicado. Puede tener tres valores: map, table o alarm.

• createdAt(string): Fecha, en formato ISO, en la que se creo el trabajo.

• resolvedAt(string): Fecha, en formato ISO, en la que se completó el trabajo.

• quantity(object): Número de entidades procesadas con éxito en el trabajo. Tiene los siguientes campos:

• datapoints(number): Número de datapoints procesados.
• timepoints(number): Número de timepoints procesados.

• alarms(number): Número de alarmas procesadas.

• hasErrors(boolean): Campo que indica si el proceso de publicación contiene errores.

• errors([]): Listado de los errores que se han ocasionado en el procesamiento del trabajo. A su vez tiene dos campos más:

  • datapoint(string): Indica el datapoint del error.

  • error(string|string[]): Es un conjunto de errores(MultiError) ocasionados en el procesamiento del trabajo.