Event Webservice

Get information about a policy alert

Get information about a policy alert

post/api/event/getPolicyAlertV2

Request

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

policyAlertUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "policyAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

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

{
  "policyAlert": {
    "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.