Get rules event records

Find rules event historical records

POST /api/rulesRecords/getRulesEventRecords

Get rules event records

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/rulesRecords/getRulesEventRecords \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "associatedUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "endTime": 1640998800000,
  "startTime": 1640995200000
}
'

200

{
  "rulesEventRecords": [
    {
      "activatedLocationLockdownRecord": {
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "succeeded": true
      },
      "alertActionRecord": {
        "policyAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "alertMonitoringEventRecords": [
        {
          "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
          "threatCaseUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "timestampMs": 123
        }
      ],
      "audioPlaybackActionRecords": [
        {
          "audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "audioGatewayStatuses": {}
        }
      ],
      "cancelLoopingAudioPlaybackActionRecordType": {
        "statusMap": {}
      },
      "changeComponentCompositeAccessStateRecords": [
        {
          "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "madeChange": true,
          "succeeded": true,
          "usedFirstIn": true,
          "willExpireAtMs": 123
        }
      ],
      "deviceEventRecords": [
        {
          "activities": [],
          "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "eventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
          "timestampMs": 123
        }
      ],
      "enableDisableAudioRecordActionRecords": [
        {
          "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "enable": true,
          "succeeded": true
        }
      ],
      "integrationActionStatuses": {},
      "liveNotificationActionRecord": {},
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledEventRecords": [
        {
          "timestampMs": 123
        }
      ],
      "triggerComponentRelayRecords": [
        {
          "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "overrideRelayDurationMs": 123,
          "overrideRelayDurationSec": 123,
          "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "succeeded": true
        }
      ],
      "triggeredTimestampMs": 123,
      "unlockDoorActionRecords": [
        {
          "doorId": "<string>",
          "placeId": "<string>",
          "succeeded": true,
          "system": "<string>"
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "visionLLMEventRecords": [
        {
          "deviceFacetUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
          "fullResponse": "<string>",
          "parsedAffirmativeResponse": true,
          "timestampMs": 123,
          "userPrompt": "<string>"
        }
      ],
      "webhookActionStatuses": {}
    }
  ]
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting rules event records.

associatedUuids · (string<RUUID> | null)[] | null

Associated uuids for devices, components, locations and componenet composites. **Optional, can be null.

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

endTime · integer<int64> | null

End time for the query period

Example:

1640998800000

startTime · integer<int64> | null

Start time for the query period

Example:

1640995200000

Response

200 - application/json

OK

Response object for getting rules event records.

rulesEventRecords · object[] | null

List of rules event records

Show child attributes