Skip to main content
POST
/
api
/
accesscontrol
/
lockdownPlan
/
createLockdownRuleForLocation
Create lockdown rule for location
curl --request POST \
  --url https://api2.rhombussystems.com/api/accesscontrol/lockdownPlan/createLockdownRuleForLocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "rule": {
    "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"
        }
      ],
      "webhookActions": [
        {
          "webhookUrl": "<string>"
        }
      ]
    },
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ruleFilters": {
      "scheduleUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "triggerBackoffSecs": 123
    },
    "ruleName": "<string>",
    "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "triggerActivity": "SOUND_LOUD"
  }
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "ruleUuid": "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 to create a new lockdown rule for a specific location.

rule
object

External representation of a lockdown plan rule configuration.

Response

200 - application/json

OK

Response containing the UUID of the created lockdown rule.

error
boolean | null
errorMsg
string | null
ruleUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

warningMsg
string | null