Warnungen

Rufen Sie In-App-Warnungsbenachrichtigungen für den aktuellen authentifizierten Benutzer ab.

API-Endpunkt

GET {accessURL}/{organizationName}/notificationservice_/notificationserviceapi/odata/v1/Alerts

Ersetzen Sie {accessURL} in allen Endpunktpfaden durch die Basis-URL für Ihre Cloud-Plattform:

Cloud Platform	Zugriffs-URL
Test Cloud	https://cloud.uipath.com/
Test Cloud Public Sector	https://govcloud.uipath.us/
Test Cloud Dedicated.	https://{customURL}.dedicated.uipath.com/

Anforderungsheader

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

Abfrageparameter

Der Endpunkt unterstützt standardmäßige OData-Abfrageoptionen in der Warnungssammlung:

1. $filter: Filterwarnungen.

   Beispiel: ?$filter=Severity eq 'High'.

2. $orderby: Warnungen sortieren.

   Beispiel: ?$orderby=CreationTime desc.

3. $top: Begrenzen Sie die Anzahl der zurückgegebenen Ergebnisse.

   Beispiel: ?$top=50.

4. $skip: Überspringen Sie eine Reihe von Ergebnissen (Paginierung).

   Beispiel: ?$skip=50&$top=50.

5. $count: Gesamtanzahl der Elemente anfordern.

   Hinweis:

   Muss ein gültiges boolesches Literal sein: "true" oder "false".

Filterbeispiele

Sehen Sie sich die folgenden Filterbeispiele an:

1. Nach Komponente: ?$filter=component eq 'Process'.

2. Nach Lesestatus (nur ungelesen): ?$filter=component eq 'Process' and state eq 'Unread'.

3. Nach Schweregrad: Das Feld severity ist eine Aufzählung. Nur Gleichheitsvergleiche auf severity werden unterstützt, zum Beispiel:

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

   Ungleichheit (ne) und Bereichsvergleiche (gt, ge, lt, le) auf severity werden nicht unterstützt und dürfen nicht in $filter -Ausdrücken verwendet werden.

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

4. Nach Zeitbereich: ?$filter=component eq 'Process' and creationTime ge 2025-01-01T00:00:00Z and creationTime lt 2025-02-01T00:00:00Z

5. In Warnungsmeldung oder -kontext suchen (data): ?$filter=component eq 'Process' and contains(data,'Timeout')

Antworten

200 OK

In-App-Warnungsbenachrichtigungen für den authentifizierten Benutzer wurden erfolgreich abgerufen.

400 Ungültige Anforderung

• Ungültige OData-Abfrage, insbesondere ein ungültiger $count -Wert (nicht boolescher Wert).
• Der Antworttext ist ein Standard-JSON-Fehlerobjekt mit einer Meldung, die auf die ungültige Anzahl der Abfrageoption hinweist.

401 Nicht autorisiert

Fehlendes oder ungültiges Bearer-Token.

403 Forbidden

Token gültig, erfüllt aber nicht die UserContext -Richtlinie oder die erforderlichen Berechtigungen.

5xx Serverfehler

Unerwartete serverseitige Ausfälle.

Beispielanforderung

Anforderung:

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'

Antwort:

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