Alertas

Recupere notificações de alerta no aplicativo para o usuário autenticado atual.

Ponto de Extremidade da API

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

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Test Cloud	https://cloud.uipath.com/
Test Cloud para o Setor Público	https://govcloud.uipath.us/
Test Cloud Dedicado	https://{customURL}.dedicated.uipath.com/

Cabeçalhos de solicitação.

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

Parâmetros de Consulta

O ponto de extremidade é compatível com opções de consulta padrão do OData na coleção Alertas:

1. $filter: filtrar alertas.

   Exemplo: ?$filter=Severity eq 'High'

2. $orderby: classifique alertas.

   Exemplo: ?$orderby=CreationTime desc

3. $top: limite o número de resultados retornados.

   Exemplo: ?$top=50

4. $skip: ignorar um número de resultados (paginação).

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

5. $count: solicite a contagem total de itens.

   Observação:

   Deve ser um literal Booleano válido: "true" ou "false".

Exemplos de filtro

Confira os seguintes exemplos de filtro:

1. Por componente: ?$filter=component eq 'Process'.

2. Por estado de leitura (apenas não lido): ?$filter=component eq 'Process' and state eq 'Unread'.

3. Por gravidade: o campo severity é um enum. Apenas as comparações de identidade em severity são compatíveis, por exemplo:

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

   As comparações de seletores (ne) e de intervalos (gt, ge, lt, le) em severity não são compatíveis e não devem ser usadas em expressões $filter .

   Por exemplo, ?$filter=component eq 'Process' and severity eq 'Warning'.

4. Por intervalo de tempo: ?$filter=component eq 'Process' and creationTime ge 2025-01-01T00:00:00Z and creationTime lt 2025-02-01T00:00:00Z

5. Pesquisar na mensagem de alerta ou no contexto (data): ?$filter=component eq 'Process' and contains(data,'Timeout')

Resposta

200 OK

As notificações de alerta no aplicativo para o usuário autenticado foram recuperadas com sucesso.

400 Bad Request

• Consulta do OData inválida, especialmente um valor $count inválido (não booleano).
• O corpo da resposta é um objeto de erro JSON padrão com uma mensagem indicando a opção de consulta de contagem inválida.

401 não autorizado

Token de portador ausente ou inválido.

403 Forbidden

O token é válido, mas não atende à política UserContext ou às permissões necessárias.

5xx Erros do servidor

Falhas inesperadas no lado do servidor.

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
}