Get rules filtered
curl --request POST \
--url https://api2.rhombussystems.com/api/rules/getRulesFiltered \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"associatedUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"ruleTypeFilter": []
}
'import requests
url = "https://api2.rhombussystems.com/api/rules/getRulesFiltered"
payload = {
"associatedUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"ruleTypeFilter": []
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({associatedUuids: ['AAAAAAAAAAAAAAAAAAAAAA'], ruleTypeFilter: []})
};
fetch('https://api2.rhombussystems.com/api/rules/getRulesFiltered', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/rules/getRulesFiltered")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"associatedUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"ruleTypeFilter\": []\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"rules": [
{
"action": {
"activateLocationLockdown": {
"locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
},
"alertAction": true,
"audioPlaybackActions": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGateways": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"loopDurationSec": 123,
"playCount": 123
}
],
"cancelLoopingAudioPlaybackAction": {
"_audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
]
},
"changeComponentCompositeAccessStateActions": [
{
"accessState": "UNLOCKED",
"alwaysCreateOverrideIfNoFirstIn": true,
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expirationStrategy": "TIME_DELAY",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": true,
"version": 123
}
],
"connectAudioDeviceToMobileAppAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceType": "BLE_TRACKER",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"targetUserUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceType": "BLE_TRACKER",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"createAlarmAction": {
"attachMediaToActiveAlarm": true,
"entryInstructions": "<string>",
"exclusiveEmergencyContact": true,
"exclusiveEntryInstructions": true,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"mediaDeviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"onsiteEmergencyContact": {
"name": "<string>",
"phoneNumber": "<string>"
},
"reason": "<string>",
"sirenSettings": {
"audioGateways": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"durationSeconds": 123,
"playCount": 123
},
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
"triggerType": "PANIC_BUTTON"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"deviceFacetUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"emailAuditLogExportActions": [
{
"includeActions": [
"<string>"
],
"includeApiInvocation": true,
"lookbackCount": 123,
"lookbackType": "ROLLING",
"lookbackUnit": "HOURS",
"recipientEmails": [
"<string>"
],
"timezoneId": "<string>"
}
],
"enableDisableAudioRecordActions": [
{
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": true
}
],
"integrationCommandActions": [
{
"commandPayload": "<string>",
"delaySecs": 123,
"integration": "AVIGILON_ALTA"
}
],
"integrationNotificationActions": [
{
"integration": "AVIGILON_ALTA",
"notificationEntity": "<string>",
"notificationTarget": "<string>"
}
],
"liveNotificationAction": true,
"remoteDoorUnlockActions": [
{
"doorId": "<string>",
"placeId": "<string>",
"system": "BRIVO"
}
],
"robotActions": [
{
"mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"navType": "ROUTE",
"pose": {
"orientation": [
123
],
"position": [
123
]
},
"routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"type": "DEPLOY"
}
],
"thirdPartyAudioPlaybackAction": {
"audioFileName": "<string>",
"ipAddress": "<string>",
"loopDurationSec": 123,
"password": "<string>",
"playCount": 123,
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"username": "<string>"
},
"thirdPartyStrobeSirenAction": {
"durationSec": 123,
"ipAddress": "<string>",
"lightColors": [
"<string>"
],
"lightIntensity": 123,
"lightPattern": "<string>",
"lightSpeed": 123,
"password": "<string>",
"profileName": "<string>",
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"sirenIntensity": 123,
"sirenPattern": "<string>",
"username": "<string>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"outputType": "TRANSIENT",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"state": "ACTIVE",
"version": 123
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookSecret": "<string>",
"webhookUrl": "<string>"
}
]
},
"conjunction": "AND",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleFilters": {
"scheduleUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"triggerBackoffSecs": 123
},
"ruleType": "BUTTON_DEFINED",
"triggers": [
{
"activityEvent": {
"activityEvent": "SOUND_LOUD"
},
"componentCompositeUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"deviceLabels": [
"<string>"
],
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"type": "DEVICE_ACTIVITY_EVENT"
}
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Rules Webservice
Get rules filtered
Get rules with Uuid and Type filtering
POST
/
api
/
rules
/
getRulesFiltered
Get rules filtered
curl --request POST \
--url https://api2.rhombussystems.com/api/rules/getRulesFiltered \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"associatedUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"ruleTypeFilter": []
}
'import requests
url = "https://api2.rhombussystems.com/api/rules/getRulesFiltered"
payload = {
"associatedUuids": ["AAAAAAAAAAAAAAAAAAAAAA"],
"ruleTypeFilter": []
}
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({associatedUuids: ['AAAAAAAAAAAAAAAAAAAAAA'], ruleTypeFilter: []})
};
fetch('https://api2.rhombussystems.com/api/rules/getRulesFiltered', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/rules/getRulesFiltered")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"associatedUuids\": [\n \"AAAAAAAAAAAAAAAAAAAAAA\"\n ],\n \"ruleTypeFilter\": []\n}")
.asString();{
"error": true,
"errorMsg": "<string>",
"rules": [
{
"action": {
"activateLocationLockdown": {
"locationLockdownPlanUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA"
},
"alertAction": true,
"audioPlaybackActions": [
{
"audioClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"audioGateways": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"loopDurationSec": 123,
"playCount": 123
}
],
"cancelLoopingAudioPlaybackAction": {
"_audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"audioDevices": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
]
},
"changeComponentCompositeAccessStateActions": [
{
"accessState": "UNLOCKED",
"alwaysCreateOverrideIfNoFirstIn": true,
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expirationStrategy": "TIME_DELAY",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": true,
"version": 123
}
],
"connectAudioDeviceToMobileAppAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceType": "BLE_TRACKER",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"targetUserUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
]
},
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceType": "BLE_TRACKER",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"createAlarmAction": {
"attachMediaToActiveAlarm": true,
"entryInstructions": "<string>",
"exclusiveEmergencyContact": true,
"exclusiveEntryInstructions": true,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"mediaDeviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"onsiteEmergencyContact": {
"name": "<string>",
"phoneNumber": "<string>"
},
"reason": "<string>",
"sirenSettings": {
"audioGateways": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"clipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"durationSeconds": 123,
"playCount": 123
},
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
"triggerType": "PANIC_BUTTON"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"deviceFacetUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"timestampMs": 123
}
],
"emailAuditLogExportActions": [
{
"includeActions": [
"<string>"
],
"includeApiInvocation": true,
"lookbackCount": 123,
"lookbackType": "ROLLING",
"lookbackUnit": "HOURS",
"recipientEmails": [
"<string>"
],
"timezoneId": "<string>"
}
],
"enableDisableAudioRecordActions": [
{
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"enable": true
}
],
"integrationCommandActions": [
{
"commandPayload": "<string>",
"delaySecs": 123,
"integration": "AVIGILON_ALTA"
}
],
"integrationNotificationActions": [
{
"integration": "AVIGILON_ALTA",
"notificationEntity": "<string>",
"notificationTarget": "<string>"
}
],
"liveNotificationAction": true,
"remoteDoorUnlockActions": [
{
"doorId": "<string>",
"placeId": "<string>",
"system": "BRIVO"
}
],
"robotActions": [
{
"mapUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"navType": "ROUTE",
"pose": {
"orientation": [
123
],
"position": [
123
]
},
"routeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"waypointUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"type": "DEPLOY"
}
],
"thirdPartyAudioPlaybackAction": {
"audioFileName": "<string>",
"ipAddress": "<string>",
"loopDurationSec": 123,
"password": "<string>",
"playCount": 123,
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"username": "<string>"
},
"thirdPartyStrobeSirenAction": {
"durationSec": 123,
"ipAddress": "<string>",
"lightColors": [
"<string>"
],
"lightIntensity": 123,
"lightPattern": "<string>",
"lightSpeed": 123,
"password": "<string>",
"profileName": "<string>",
"proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"sirenIntensity": 123,
"sirenPattern": "<string>",
"username": "<string>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"outputType": "TRANSIENT",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"state": "ACTIVE",
"version": 123
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookSecret": "<string>",
"webhookUrl": "<string>"
}
]
},
"conjunction": "AND",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ruleFilters": {
"scheduleUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"triggerBackoffSecs": 123
},
"ruleType": "BUTTON_DEFINED",
"triggers": [
{
"activityEvent": {
"activityEvent": "SOUND_LOUD"
},
"componentCompositeUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"deviceLabels": [
"<string>"
],
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"locationUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"type": "DEVICE_ACTIVITY_EVENT"
}
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Authorizations
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
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 filtered rules.
List of associated UUIDs to filter by
base 64 (url-safe) uuid string
Example:
"AAAAAAAAAAAAAAAAAAAAAA"
List of rule types to filter by
Available options:
BUTTON_DEFINED, USER_DEFINED, DOORBELL_CAMERA_DEFINED, DOOR_CONTROLLER_DEFINED, LOCKDOWN_PLAN_DEFINED, CUSTOM_LLM_DEFINED, ROBOT_DEFINED, SCHEDULED_REPORT_DEFINED Last modified on August 21, 2026
⌘I