Integraciones
Integraciones
Breadcrumbs

Operaciones con Notificaciones

Introducción

A continuación se resaltan las operaciones básicas que se pueden realizar por API respecto a las Notificaciones. Todas las llamadas se encuentran en Hermes. Para más detalles de los endpoints, se puede consultar Swagger

Obtener todas las notificaciones enviadas

Permite obtener todas las notificaciones enviadas según los criterios de búsqueda informados, siempre y cuando el usuario que realiza la petición es receptor de ellas (ya sea por nombre o por su rol y unidad organizativa)

Consiste en la llamada:

POST https://{{host}}/gateway/api/admin/hermes/notification

Es obligatorio filtrar por al menos una variable, en caso contrario recibiremos un error 400 bad request.

En ese endpoint es recomendable incluir la cabecera de “x-language”, ya que las notificaciones siempre contienen valores traducidos.

Enviar una notificación

Permite enviar una notificación a un usuario o cualquier rol con los parámetros que se quiera.

Se realiza la llamada:

POST https://{{host}}/gateway/api/admin/hermes/send

El cuerpo de la petición es el siguiente:

JSON
{
    "senderUser": "maria.gonzalez",
    "moduleType": "DC",
    "notificationReceiverType": "USER",
    "notificationType": "NOTICE",
    "read": false,
    "severity": "HIGH",
    "typeObject": "ENTITY",
    "subtypeObject": "DATASET",
    "idObject": 2247,
    "redirectionType": "OBJECT",
    "objectName": "",
    "objectVersion": "0",
    "organizationalUnit": "SPA/Finance",
    "idNotification": 7,
    "execution": null,
    "task": "",
    "creationDate": "2023-11-30T17:09:00.000Z",
    "endDate": null,
    "receiverUser": "maria.gonzalez",
    "receiverRole": null,
    "messageKey": "NOTIFICATION.7.DC.USER",
    "messageParams": null
}

A continuación, se explica cada variable:

  • senderUser Usuario que envía la notificación

  • moduleType Módulo de la notificación. Valores posibles: ALL, DC y BG

  • notificationReceiverType Tipo de receptor. Valores posibles: USER y ROLE

  • notificationType Tipo de notificación. Valores posibles: NOTICE, ALERT y ADMIN_ALERT.

  • read Indica si la notificación ha sido leída

  • severity Importancia de la notificación. Valores posibles: LOW, MEDIUM y HIGH

  • typeObject Tipo de objeto. Valores posibles: ENTITY y RELATIONSHIP

  • subtypeObject Subtipo de objeto. Ej: DATASET, DSA, INSTANCE… o subtipos propios del cliente definidos en la tabla ObjectSubType

  • idObject Id interno del objeto

  • redirectionType tipo de redirección de la notificación

  • objectName Nombre del objeto

  • objectVersion Versión del objeto

  • organizationalUnit Unidad Organizativa

  • idNotification Identificador de la notificación definida en la tabla Notification.

  • execution Identificador del workflow en caso de ser una notificación asociada a una ejecución.

  • task Nombre de la tarea relacionada con la notificación

  • creationDate Fecha de creación de la notificación

  • endDate Fecha de fin de la notificación

  • receiverUser Usuario que recibe la notificación en caso de ser una notificación cuyo notificationReceiverType sea USER

  • receiverRole Usuario que recibe la notificación en caso de ser una notificación cuyo notificationReceiverType sea ROLE

  • messageKey Clave de traducción del mensaje de la notificación

  • messageParams Mapa de variables de la notificación que se sustituirán por su valor correspondiente en la traducción del messageKey.