Event Webservice

Get recent policy alerts for organization

Get recent policy alerts for organization

post/api/event/getPolicyAlertsV2

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/event/getPolicyAlertsV2
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

afterTimestampMsinteger nullable

Filter for alerts after this timestamp

beforeTimestampMsinteger nullable

Filter for alerts before this timestamp

deviceFilterstring[] nullable

List of device UUIDs to filter by

lastTimestampMsinteger nullable

Last timestamp for pagination

lastUuidstring RUUID nullable

base 64 (url-safe) uuid string

locationFilterstring[] nullable

List of location UUIDs to filter by

maxResultsinteger nullable

Maximum number of results to return

Example request

{
  "afterTimestampMs": 1640995200000,
  "beforeTimestampMs": 1641081600000,
  "deviceFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "lastTimestampMs": 1640995200000,
  "lastUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "locationFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "maxResults": 100
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "oldestPolicyAlert": {
    "alertingDwellEvents": [
      {
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "regionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "alertingEventFaces": [
      {
        "personUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "cllmPromptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "egressBoundaryDevices": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "ingressBoundaryDevices": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "policyAlerts": [
    {
      "alertingDwellEvents": [
        {
          "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "regionUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "alertingEventFaces": [
        {
          "personUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "cllmPromptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "egressBoundaryDevices": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "ingressBoundaryDevices": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.