Orchestrator API ガイド

デリバリー:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

最終更新日時 2024年12月9日

アラートの要求

アラートを既読にする

この要求では、ユーザーがアクセスできるテナントで 1 つ以上のアラートを既読としてマークできます。

POST

https://{yourDomain}/odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead

要求ヘッダー

キー	値 (Value)
認可	Bearer

要求本文

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

応答コード

200 OK

応答本文

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

重要: 要求本文に、ペイロードの "ids" フィールドの値として UserNotificationId が含まれている必要があります。UserNotificationId を確認するには、まず /odata/Alerts エンドポイントに GET 要求を送信します。

たとえば、GET /odata/Alerts を呼び出すと、次の応答本文が返されます。

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

"UserNotificationId" の値 (197ed863-037b-4d89-8271-c04e30b52240) を POST /odata/Alerts/UiPath.Server.Configuration.OData.MarkAsRead エンドポイントの要求本文の "ids" キーにマップします。