🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
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
}
'{
"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": 123
}
],
"audioPlaybackActionRecords": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGatewayStatuses": {}
}
],
"cancelLoopingAudioPlaybackActionRecordType": {
"statusMap": {}
},
"deviceEventRecords": [
{
"activities": [
"SOUND_LOUD"
],
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceType": "BLE_TRACKER",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"eventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"hardwareVariation": "RASPBERRY_PI_3",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"enableDisableAudioRecordActionRecords": [
{
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": true
}
],
"integrationActionStatuses": {},
"liveNotificationActionRecord": {
"status": "SUCCESS"
},
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"scheduledEventRecords": [
{
"timestampMs": 123
}
],
"triggerComponentRelayRecords": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"outputType": "TRANSIENT",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"state": "ACTIVE",
"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": {}
}
]
}Find rules event historical records
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
}
'{
"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": 123
}
],
"audioPlaybackActionRecords": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGatewayStatuses": {}
}
],
"cancelLoopingAudioPlaybackActionRecordType": {
"statusMap": {}
},
"deviceEventRecords": [
{
"activities": [
"SOUND_LOUD"
],
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceType": "BLE_TRACKER",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"eventUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"hardwareVariation": "RASPBERRY_PI_3",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"enableDisableAudioRecordActionRecords": [
{
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": true
}
],
"integrationActionStatuses": {},
"liveNotificationActionRecord": {
"status": "SUCCESS"
},
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"scheduledEventRecords": [
{
"timestampMs": 123
}
],
"triggerComponentRelayRecords": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"outputType": "TRANSIENT",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"state": "ACTIVE",
"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": {}
}
]
}Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9Request object for getting rules event records.
Associated uuids for devices, components, locations and componenet composites. **Optional, can be null.
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
End time for the query period
1640998800000
Start time for the query period
1640995200000
OK
Response object for getting rules event records.
List of rules event records
Show child attributes
Was this page helpful?