Alertas

Recuperar notificaciones de alerta en la aplicación para el usuario autenticado actual.

Punto final de API

GET https://cloud.uipath.com/{organizationName}/notificationservice_/notificationserviceapi/odata/v1/Alerts

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Parámetros de consulta

El punto final admite opciones de consulta estándar de OData en la colección Alertas:

1. $filter: filtrar alertas.
   Ejemplo: ?$filter=Severity eq 'High'
2. $orderby: Ordenar alertas.
   Ejemplo: ?$orderby=CreationTime desc
3. $top: limita el número de resultados devueltos.
   Ejemplo: ?$top=50
4. $skip: omitir un número de resultados (paginación).
   Ejemplo: ?$skip=50&$top=50
5. $count: Solicitar recuento total de elementos.
   Nota: Debe ser un literal booleano válido: "true" o "false".

Ejemplos de filtros

Consulta los siguientes ejemplos de filtros:

1. Por componente: ?$filter=component eq 'Process'.
2. Por estado de lectura (solo no leído) ?$filter=component eq 'Process' and state eq 'Unread'.
3. Por gravedad: el campo severity es una enumeración. Solo se admiten las comparaciones de igualdad en severity , por ejemplo:
   • gravedad eq 'Advertencia'
   • gravedad en ('Info','Advertencia')
   Las comparaciones de desigualdad (ne) y rango (gt, ge, lt, le) en severity no son compatibles y no deben utilizarse en expresiones $filter .
   Por ejemplo ?$filter=component eq 'Process' and severity eq 'Warning'.
4. Por intervalo de tiempo: ?$filter=component eq 'Process' and creationTime ge 2025-01-01T00:00:00Z and creationTime lt 2025-02-01T00:00:00Z
5. Buscar en mensaje de alerta o contexto (data): ?$filter=component eq 'Process' and contains(data,'Timeout')

Respuesta

200 OK

Las notificaciones de alerta en la aplicación para el usuario autenticado se recuperaron correctamente.

400 Bad Request

• Consulta de OData no válida, en particular un valor $count no válido (no booleano).

• El cuerpo de la respuesta es un objeto de error JSON estándar con un mensaje que indica la opción de consulta de recuento no válida.

401 No autorizado

Token de portador faltante o no válido.

403 Forbidden

El token es válido pero no cumple la política UserContext ni los permisos necesarios.

Errores del servidor 5xx

Fallos inesperados del lado del servidor.

Solicitud de ejemplo

Solicitud:

curl --location --request GET \
  'https://cloud.uipath.com/{organizationName}/notificationservice_/notificationserviceapi/odata/v1/Alerts?$top=50&$skip=0&$orderby=creationTime desc&$count=true' \
  --header 'Authorization: Bearer {access_token}' \
  --header 'Accept: application/json'

Respuesta:

{
  "value": [
    {
      "id": "<identifier>",
      "notificationName": "Robot.StatusChanged.NotResponding",
      "data": "{\"robotId\": 123, \"machineName\": \"<machineName>\"}",
      "component": "Orchestrator",
      "severity": "Warning",
      "creationTime": "2025-01-01T12:34:56Z",
      "state": "Unread",
      "userNotificationId": "<userNotificationId>",
      "deepLinkRelativeUrl": "/alerts/deeplink/robot-not-responding?robotId=123"
    }
  ],
  "@odata.count": 1
}