Skip to main content
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": [
    "BUTTON_DEFINED"
  ]
}
'
{
  "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"
          ]
        },
        "connectAudioDeviceToPhoneNumberAction": {
          "audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "deviceType": "BLE_TRACKER",
          "doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "optionalGreeting": "<string>",
          "phoneNumber": "<string>"
        },
        "customLLMActions": [
          {
            "deviceFacetUuids": [
              "AAAAAAAAAAAAAAAAAAAAAA.v0"
            ],
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "promptUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "timestampMs": 123
          }
        ],
        "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"
          }
        ],
        "thirdPartyAudioPlaybackAction": {
          "audioFileName": "<string>",
          "ipAddress": "<string>",
          "loopDurationSec": 123,
          "password": "<string>",
          "playCount": 123,
          "proxyDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
          "username": "<string>"
        },
        "triggerComponentRelayActions": [
          {
            "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "outputType": "TRANSIENT",
            "overrideRelayDurationMs": 123,
            "overrideRelayDurationSec": 123,
            "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "state": "ACTIVE",
            "version": 123
          }
        ],
        "webhookActions": [
          {
            "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

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting filtered rules.

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

List of associated UUIDs to filter by

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

ruleTypeFilter
enum<string>[] | null

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

Response

200 - application/json

OK

Response object for getting rules for an organization.

error
boolean | null
errorMsg
string | null
rules
object[] | null

List of rules for the organization

warningMsg
string | null