Alertas

Retrieve in‑app alert notifications for the current authenticated user.

Ponto de Extremidade da API

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

Cabeçalhos de solicitação.

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

Parâmetros de Consulta

The endpoint supports standard OData query options on the Alerts collection:

1. $filter: Filter alerts.
   Exemplo: ?$filter=Severity eq 'High'
2. $orderby: Sort alerts.
   Exemplo: ?$orderby=CreationTime desc
3. $top: Limit the number of results returned.
   Exemplo: ?$top=50
4. $skip: Skip a number of results (paging).
   Exemplo: ?$skip=50&$top=50
5. $count: Request total count of items.
   Note: Must be a valid Boolean literal: "true" or "false".

Filter examples

Check out the following filter examples:

1. By component: ?$filter=component eq 'Process'.
2. By read state (unread only) ?$filter=component eq 'Process' and state eq 'Unread'.
3. By severity: The severity field is an enum. Only equality comparisons on severity are supported, for example:
   • severity eq 'Warning'
   • severity in ('Info','Warning')
   Inequality (ne) and range comparisons (gt, ge, lt, le) on severity are not supported and must not be used in $filter expressions.
   Por exemplo, ?$filter=component eq 'Process' and severity eq 'Warning'.
4. By time range: ?$filter=component eq 'Process' and creationTime ge 2025-01-01T00:00:00Z and creationTime lt 2025-02-01T00:00:00Z
5. Search in alert message or context (data): ?$filter=component eq 'Process' and contains(data,'Timeout')

Resposta

200 OK

In-app alert notifications for the authenticated user were retrieved successfully.

400 Bad Request

• Invalid OData query, particularly an invalid $count value (non-Boolean).

• Response body is a standard JSON error object with a message indicating the invalid count query option.

401 não autorizado

Missing or invalid bearer token.

403 Forbidden

Token valid but does not satisfy the UserContext policy or required permissions.

5xx Server Errors

Unexpected server-side failures.

Exemplo de solicitação

Solicitação:

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'

Resposta:

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