Event Webservice

Get recent policy alerts for organization, grouped by time

Get recent policy alerts for organization, grouped by time. Groups are constructed of alerts that occur within 2 minutes of the previous alert, up to a maximum of 50. Results are returned in reverse-chronological order, so all fields are relative to that ordering.

post/api/event/getPolicyAlertGroupsV2

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/event/getPolicyAlertGroupsV2
  • 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

lastTimestampMsinteger nullable

Last timestamp for pagination

lastUuidstring RUUID nullable

base 64 (url-safe) uuid string

maxResultsinteger nullable

Maximum number of results to return

Example request

{
  "lastTimestampMs": 1640995200000,
  "lastUuid": "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

{
  "policyAlertGroups": [
    {
      "endTime": 1641081600000,
      "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"
          ]
        }
      ],
      "startTime": 1640995200000
    }
  ]
}

Changes

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