Event Webservice

Get alert monitoring threat cases

Get alert monitoring threat cases

post/api/event/getAlertMonitoringThreatCases

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/event/getAlertMonitoringThreatCases
  • 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 threat cases after this timestamp

beforeTimestampMsinteger nullable

Filter for threat cases before this timestamp

deviceFilterstring[] nullable

List of device UUIDs to filter by

lastEvaluatedKeystring nullable
lastTimestampMsinteger nullable

Last timestamp for pagination

lastUuidstring RUUID nullable

base 64 (url-safe) uuid string

locationFilterstring[] nullable

List of location UUIDs to filter by

maxPageSizeinteger nullable
maxResultsinteger nullable

Maximum number of results to return

mostRecentboolean nullable

Whether to return only the most recent threat cases

statusFilterThreatCaseStatusEnum[] nullable

List of threat case statuses to filter by

Example request

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

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
lastEvaluatedKeystring nullable
warningMsgstring nullable

Example response

{
  "threatCases": [
    {
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "policyAlertComponentCompositeUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "policyAlertDeviceUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "policyAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "policyAlertUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "sharedClipGroupUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "sirenSettings": {
        "audioGateways": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "timelineEventList": [
        {
          "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "reviewerPinUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "verificationHistory": {
        "currentVerification": {
          "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
        },
        "verificationRecords": [
          {
            "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
          }
        ]
      }
    }
  ]
}

Changes

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