Rules Records

Get latest rules event records

Get N latest rules event historical records

POST/api/rulesRecords/getLatestRulesEventRecords

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

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

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for getting latest rules event records.

associatedUuidsstring<RUUID>[] | nullbody

List of associated UUIDs to filter by

ninteger<int32> | nullbody

Number of latest records to retrieve

Example: 10

ruleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/rulesRecords/getLatestRulesEventRecords' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "associatedUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "n": 10,
    "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }'

import requests

url = "https://api2.rhombussystems.com/api/rulesRecords/getLatestRulesEventRecords"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "associatedUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "n": 10,
    "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/rulesRecords/getLatestRulesEventRecords', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "associatedUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "n": 10,
    "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "associatedUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ],
              "n": 10,
              "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/rulesRecords/getLatestRulesEventRecords"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "rulesEventRecords": [
    {
      "activatedLocationLockdownRecord": {
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "lockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "succeeded": true
      },
      "alertActionRecord": {
        "policyAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "status": "SUCCESS"
      },
      "alertMonitoringEventRecords": [
        {
          "alertMonitoringEventType": "ALARM_CREATED",
          "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
          "threatCaseUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "timestampMs": 0
        }
      ],
      "audioPlaybackActionRecords": [
        {
          "audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "audioGatewayStatuses": {}
        }
      ],
      "cancelLoopingAudioPlaybackActionRecordType": {
        "statusMap": {
          "<key>": "SUCCESS"
        }
      },
      "changeComponentCompositeAccessStateRecords": [
        {
          "accessState": "UNLOCKED",
          "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "madeChange": true,
          "succeeded": true,
          "usedFirstIn": true,
          "willExpireAtMs": 0
        }
      ],
      "createAlarmRecord": {
        "alarmId": "<string>",
        "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "outcome": "<string>",
        "succeeded": true,
        "threatCaseUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "deviceEventRecords": [
        {
          "activities": [],
          "componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "deviceType": "BLE_TRACKER",
          "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "eventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "hardwareVariation": "RASPBERRY_PI_3",
          "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
          "timestampMs": 0
        }
      ],
      "enableDisableAudioRecordActionRecords": [
        {
          "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "enable": true,
          "succeeded": true
        }
      ],
      "integrationActionStatuses": {
        "<key>": "SUCCESS"
      },
      "liveNotificationActionRecord": {
        "status": "SUCCESS"
      },
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledEventRecords": [
        {
          "timestampMs": 0
        }
      ],
      "triggerComponentRelayRecords": [
        {
          "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "outputType": "TRANSIENT",
          "overrideRelayDurationMs": 0,
          "overrideRelayDurationSec": 0,
          "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "state": "ACTIVE",
          "succeeded": true
        }
      ],
      "triggeredTimestampMs": 0,
      "unlockDoorActionRecords": [
        {
          "doorId": "<string>",
          "placeId": "<string>",
          "succeeded": true,
          "system": "<string>"
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "visionLLMEventRecords": [
        {
          "deviceFacetUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
          "fullResponse": "<string>",
          "parsedAffirmativeResponse": true,
          "timestampMs": 0,
          "userPrompt": "<string>"
        }
      ],
      "webhookActionStatuses": {
        "<key>": true
      }
    }
  ]
}

Response

200 OK

application/json · object

Response object for getting latest rules event records.

rulesEventRecordsobject[] | null

List of latest rules event records

Show child attributes

activatedLocationLockdownRecordobject

Show child attributes

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

lockdownPlanUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

succeededboolean | null

alertActionRecordobject

Show child attributes

policyAlertUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

statusenum<string>

Available options: SUCCESS, ERROR, PAUSED, IGNORED, MUTED, BACKOFF, UNKNOWN

alertMonitoringEventRecordsobject[] | null

Show child attributes

alertMonitoringEventTypeenum<string>

Available options: ALARM_CREATED, ALARM_CANCELED, UNKNOWN

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

threatCaseUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

timestampMsinteger<int64> | null

audioPlaybackActionRecordsobject[] | null

Show child attributes

audioClipUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

audioGatewayStatusesobject | null

cancelLoopingAudioPlaybackActionRecordTypeobject

Show child attributes

statusMapobject | null

changeComponentCompositeAccessStateRecordsobject[] | null

Show child attributes

accessStateenum<string>

Available options: UNLOCKED, ACCESS_CONTROLLED

componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

madeChangeboolean | null

succeededboolean | null

usedFirstInboolean | null

willExpireAtMsinteger<int64> | null

createAlarmRecordobject

Show child attributes

alarmIdstring | null

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

outcomestring | null

succeededboolean | null

threatCaseUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceEventRecordsobject[] | null

Show child attributes

activitiesenum<string>[] | null

componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceTypeenum<string>

Available options: BLE_TRACKER, CAMERA, DOOR_SENSOR, ENVIRONMENTAL_SENSOR, OCCUPANCY_SENSOR, AUDIO_GATEWAY, EXECUTABLE, BADGE_READER, DOOR_CONTROLLER, BLE_BUTTON, IO_BOARD, ENVIRONMENTAL_GATEWAY, NVR, ROBOT, UNKNOWN

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

eventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

hardwareVariationenum<string>

Available options: RASPBERRY_PI_3, CAMERA_R1, CAMERA_R2, CAMERA_R2_LONG_RANGE, CAMERA_R2_180, CAMERA_R3, CAMERA_R4, CAMERA_R100, CAMERA_R120, CAMERA_R170, CAMERA_R200, CAMERA_R500, CAMERA_R510, CAMERA_R520, CAMERA_R600, SENSOR_ASSET_TAG_T1, SENSOR_DOOR_D1, SENSOR_DOOR_D20, SENSOR_ENVIRONMENTAL_E1, SENSOR_ENVIRONMENTAL_E15, SENSOR_ENVIRONMENTAL_E2, SENSOR_MOTION_M1, SENSOR_MOTION_M15, GATEWAY_A1, GATEWAY_A100, GATEWAY_ENVIRONMENTAL_E50, CAMERA_R220, CAMERA_R230, CAMERA_R36S, CAMERA_R410, CAMERA_R540, CAMERA_R545, BADGE_READER_DR1, BADGE_READER_DR40, BADGE_READER_DR20, DOOR_CONTROLLER_DC1, DOOR_CONTROLLER_DC20, DOOR_CONTROLLER_DC10, ETHERNET_TESTER_ET1, IO_BOARD_TB1, BLE_BUTTON_B10, BLE_BUTTON_B15, CAMERA_THIRD_PARTY_RELAY, CAMERA_THIRD_PARTY_NVR, CAMERA_THIRD_PARTY_NVR_MULTISENSOR, NVR_N100, CAMERA_R130, NVR_N500, CAMERA_R150, ROBOT_RC1, CAMERA_R210, CAMERA_R650, NVR_N550, NVR_N551, ROBOT_RC2, UNSPECIFIED

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

timestampMsinteger<int64> | null

enableDisableAudioRecordActionRecordsobject[] | null

Show child attributes

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

enableboolean | null

succeededboolean | null

integrationActionStatusesobject | null

liveNotificationActionRecordobject

Show child attributes

statusenum<string>

Available options: SUCCESS, ERROR, IGNORED, MUTED, BACKOFF, UNKNOWN

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ruleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

scheduledEventRecordsobject[] | null

Show child attributes

timestampMsinteger<int64> | null

triggerComponentRelayRecordsobject[] | null

Show child attributes

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

outputTypeenum<string>

Available options: TRANSIENT, STEADY

overrideRelayDurationMsinteger<int32> | null

overrideRelayDurationSecinteger<int32> | null

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

stateenum<string>

Available options: ACTIVE, INACTIVE, UNKNOWN

succeededboolean | null

triggeredTimestampMsinteger<int64> | null

unlockDoorActionRecordsobject[] | null

Show child attributes

doorIdstring | null

placeIdstring | null

succeededboolean | null

systemstring | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

visionLLMEventRecordsobject[] | null

Show child attributes

deviceFacetUuidstring<DeviceFacetUuid> | null

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

fullResponsestring | null

parsedAffirmativeResponseboolean | null

timestampMsinteger<int64> | null

userPromptstring | null

webhookActionStatusesobject | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.