Event Webservice

Get recent policy alerts for organization

Get recent policy alerts for organization

post/api/event/getPolicyAlerts

Request

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

accessControlledDoorFilterstring[] nullable

Filter including chosen Access Controlled Doors

afterTimestampMsinteger nullable

Enter starting timestamp interval in UNIX ms

beforeTimestampMsinteger nullable

Enter ending timestamp interval in UNIX ms

deviceFilterstring[] nullable

Filter including chosen Devices

lastTimestampMsinteger nullable

Search with last known TimestampMs (Required for Pagination)

lastUuidstring RUUID nullable

base 64 (url-safe) uuid string

locationFilterstring[] nullable

Filter any locations you would like to include

maxResultsinteger nullable

Set a max result limit

Example request

{
  "accessControlledDoorFilter": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "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

{
  "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"
      ],
      "alertMonitoringThreatCaseUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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