Guia da API do Orchestrator

ENTREGA:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Última atualização 20 de nov de 2024

Solicitações de alertas

Marcar alertas como lidos

Essa solicitação permite marcar um ou mais alertas como lidos no locatário ao qual o usuário tem acesso.

Postar

https://govcloud.uipath.us/{organizationName}/{tenantName}/orchestrator_/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead

Cabeçalhos de solicitação.

Chave	Valor
Autorização	O portador

Corpo da Solicitação

{
    "ids": [
      "197ed863-037b-4d89-8271-c04e30b52240"
    ]
}{
    "ids": [
      "197ed863-037b-4d89-8271-c04e30b52240"
    ]
}

Código de resposta

200 OK

Corpo da Resposta

{
    "value": 12
}{
    "value": 12
}

Importante: o corpo da solicitação deve conter o UserNotificationId como valor para o campo "ids" da carga útil. Para descobrir o UserNotificationId, faça primeiro uma solicitação GET para o terminal /odata/Alerts .

Por exemplo, chamar GET /odata/Alerts retorna o seguinte corpo de resposta:

{
  "value": [
    {
      "NotificationName": "Robot.StatusChanged.Offline",
      "Data": "{\"RobotId\":123,\"RobotName\":\"user@uipath.com-unattended\",\"State\":2,\"IsUnresponsive\":false,\"OrganizationUnitId\":null,\"HostMachineName\":\"MachineName\",\"ReportingTime\":\"2021-08-20T16:48:43.76\",\"Message\":\"#robot Robot(user@uipath.com-unattended) disconnected. (#1222)\",\"MessageErrorCode\":1222,\"FolderId\":null,\"FolderFullyQualifiedName\":null,\"ForceDisplay\":false,\"Type\":\"UiPath.Orchestrator.Core.Alerts.Model.RobotStatusNotification\",\"Properties\":{}}",
      "Component": "Robots",
      "Severity": "Fatal",
      "CreationTime": "2021-08-20T16:48:50.02Z",
      "State": "Unread",
      "UserNotificationId": "197ed863-037b-4d89-8271-c04e30b52240",
      "Id": "a258f4c5-7465-40f8-a650-02228353fd4e"
    }
  ]
}{
  "value": [
    {
      "NotificationName": "Robot.StatusChanged.Offline",
      "Data": "{\"RobotId\":123,\"RobotName\":\"user@uipath.com-unattended\",\"State\":2,\"IsUnresponsive\":false,\"OrganizationUnitId\":null,\"HostMachineName\":\"MachineName\",\"ReportingTime\":\"2021-08-20T16:48:43.76\",\"Message\":\"#robot Robot(user@uipath.com-unattended) disconnected. (#1222)\",\"MessageErrorCode\":1222,\"FolderId\":null,\"FolderFullyQualifiedName\":null,\"ForceDisplay\":false,\"Type\":\"UiPath.Orchestrator.Core.Alerts.Model.RobotStatusNotification\",\"Properties\":{}}",
      "Component": "Robots",
      "Severity": "Fatal",
      "CreationTime": "2021-08-20T16:48:50.02Z",
      "State": "Unread",
      "UserNotificationId": "197ed863-037b-4d89-8271-c04e30b52240",
      "Id": "a258f4c5-7465-40f8-a650-02228353fd4e"
    }
  ]
}

Mapeie o valor "UserNotificationId" (ou seja, 197ed863-037b-4d89-8271-c04e30b52240) para a chave "ids" no corpo da solicitação do ponto de extremidade POST /odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead .

Nesta página