Alertes

Référence de l'API d'alerte pour Test Cloud privé, y compris les points de terminaison, les champs de demande et les détails de la réponse.

Récupérez les notifications d'alerte dans l'application pour l'utilisateur authentifié actuel.

Point de terminaison de l’API

GET https://{yourDomain}/{organizationName}/notificationservice_/notificationserviceapi/odata/v1/Alerts

En-têtes de requête.

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

Paramètres de requête

Le point de terminaison prend en charge les options de requête OData standard de la collection Alertes :

1. $filter: filtrer les alertes.

   Exemple : ?$filter=Severity eq 'High'

2. $orderby: Trier les alertes.

   Exemple : ?$orderby=CreationTime desc

3. $top: limitez le nombre de résultats renvoyés.

   Exemple : ?$top=50

4. $skip: ignorer un certain nombre de résultats (pagination).

   Exemple : ?$skip=50&$top=50

5. $count: le nombre total d’éléments de la demande.

   Remarque :

   Doit être un littéral booléen valide : "true" ou "false".

Exemples de filtres

Consultez les exemples de filtres suivants :

1. Par composant : ?$filter=component eq 'Process'.

2. Par état lu (non lu uniquement) : ?$filter=component eq 'Process' and state eq 'Unread'.

3. Par gravité : le champ severity est une énumération. Seules les comparaisons d'égalité sur severity sont prises en charge, par exemple :

   • severity eq 'Warning'
   • severity in ('Info','Warning')

   Les comparaisons d'inégalité (ne) et de plage (gt, ge, lt, le) sur severity ne sont pas prises en charge et ne doivent pas être utilisées dans $filter expressions.

   Exemple :
   ?$filter=component eq 'Process' and severity eq 'Warning'.

4. Par plage de temps : ?$filter=component eq 'Process' and creationTime ge 2025-01-01T00:00:00Z and creationTime lt 2025-02-01T00:00:00Z

5. Rechercher dans le contexte ou dans le message d’alerte (data) : ?$filter=component eq 'Process' and contains(data,'Timeout')

Réponses

200 OK

Les notifications d'alerte intégrées à l'application pour l'utilisateur authentifié ont été récupérées avec succès.

400 Requête incorrecte

• Requête OData non valide, notamment une valeur $count non valide.
• Le corps de la réponse est un objet d'erreur JSON standard avec un message indiquant l'option de requête de comptage non valide.

401 Non autorisé

Jeton de porteur manquant ou non valide.

403 Forbidden

Jeton valide mais ne satisfait pas à la stratégie UserContext ni aux autorisations requises.

5xx erreurs de serveur

Échecs inattendues côté serveur.

Exemple de requête

Requête :

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'

Réponse :

{
  "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
}