Skip to main content
POST
/
api
/
policy
/
getPoliciesUsingSchedule
Get policies using schedule
curl --request POST \
  --url https://api2.rhombussystems.com/api/policy/getPoliciesUsingSchedule \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "accessControlledDoorPolicyList": [
    {
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledTriggers": [
        {
          "schedule": {
            "intervalList": [
              {
                "minuteOfWeekStart": 123,
                "minuteOfWeekStop": 123
              }
            ],
            "mutable": true,
            "name": "<string>",
            "oneTimeUse": true,
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "strategy": "WEEKLY_REPEATING_MINUTES",
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerSet": [
            "SOUND_LOUD"
          ]
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "audioPolicyList": [
    {
      "defaultTriggers": [
        {
          "activity": "SOUND_LOUD",
          "threshold": 123
        }
      ],
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledTriggers": [
        {
          "schedule": {
            "intervalList": [
              {
                "minuteOfWeekStart": 123,
                "minuteOfWeekStop": 123
              }
            ],
            "mutable": true,
            "name": "<string>",
            "oneTimeUse": true,
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "strategy": "WEEKLY_REPEATING_MINUTES",
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerSet": [
            {
              "activity": "SOUND_LOUD",
              "threshold": 123
            }
          ]
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "cameraPolicyList": [
    {
      "defaultTriggers": [
        {
          "activity": "SOUND_LOUD",
          "faceAlertLabelSet": [
            "<string>"
          ],
          "faceAlertUnidentified": true,
          "faceAllowedLabelSet": [
            "<string>"
          ],
          "threshold": 123,
          "vehicleAlertLabelSet": [
            "<string>"
          ],
          "vehicleAlertUnidentified": true,
          "vehicleAllowedLabelSet": [
            "<string>"
          ]
        }
      ],
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledTriggers": [
        {
          "schedule": {
            "intervalList": [
              {
                "minuteOfWeekStart": 123,
                "minuteOfWeekStop": 123
              }
            ],
            "mutable": true,
            "name": "<string>",
            "oneTimeUse": true,
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "strategy": "WEEKLY_REPEATING_MINUTES",
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerSet": [
            {
              "activity": "SOUND_LOUD",
              "faceAlertLabelSet": [
                "<string>"
              ],
              "faceAlertUnidentified": true,
              "faceAllowedLabelSet": [
                "<string>"
              ],
              "threshold": 123,
              "vehicleAlertLabelSet": [
                "<string>"
              ],
              "vehicleAlertUnidentified": true,
              "vehicleAllowedLabelSet": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "climatePolicyList": [
    {
      "backoffAlertSecs": {},
      "defaultTriggers": [
        {
          "activity": "SOUND_LOUD",
          "threshold": 123
        }
      ],
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledTriggers": [
        {
          "schedule": {
            "intervalList": [
              {
                "minuteOfWeekStart": 123,
                "minuteOfWeekStop": 123
              }
            ],
            "mutable": true,
            "name": "<string>",
            "oneTimeUse": true,
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "strategy": "WEEKLY_REPEATING_MINUTES",
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerSet": [
            {
              "activity": "SOUND_LOUD",
              "threshold": 123
            }
          ]
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "doorPolicyList": [
    {
      "defaultAjarThresholdSec": 123,
      "defaultTriggers": [
        "SOUND_LOUD"
      ],
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledTriggers": [
        {
          "ajarThresholdSec": 123,
          "schedule": {
            "intervalList": [
              {
                "minuteOfWeekStart": 123,
                "minuteOfWeekStop": 123
              }
            ],
            "mutable": true,
            "name": "<string>",
            "oneTimeUse": true,
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "strategy": "WEEKLY_REPEATING_MINUTES",
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerSet": [
            "SOUND_LOUD"
          ]
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "occupancyPolicyList": [
    {
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledTriggers": [
        {
          "occupancyThresholdSec": 123,
          "schedule": {
            "intervalList": [
              {
                "minuteOfWeekStart": 123,
                "minuteOfWeekStop": 123
              }
            ],
            "mutable": true,
            "name": "<string>",
            "oneTimeUse": true,
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "strategy": "WEEKLY_REPEATING_MINUTES",
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerSet": [
            "SOUND_LOUD"
          ],
          "vacancyThresholdSec": 123
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "proximityPolicyList": [
    {
      "defaultDepartureThresholdSec": 123,
      "defaultTriggers": [
        {
          "activity": "SOUND_LOUD",
          "locationUuids": [
            "AAAAAAAAAAAAAAAAAAAAAA"
          ]
        }
      ],
      "description": "<string>",
      "egressThresholdMetersMap": {},
      "ingressThresholdMetersMap": {},
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledTriggers": [
        {
          "departureThresholdSec": 123,
          "egressThresholdMetersMap": {},
          "ingressThresholdMetersMap": {},
          "schedule": {
            "intervalList": [
              {
                "minuteOfWeekStart": 123,
                "minuteOfWeekStop": 123
              }
            ],
            "mutable": true,
            "name": "<string>",
            "oneTimeUse": true,
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "strategy": "WEEKLY_REPEATING_MINUTES",
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerSet": [
            {
              "activity": "SOUND_LOUD",
              "locationUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ]
            }
          ]
        }
      ],
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "videoIntercomPolicyList": [
    {
      "description": "<string>",
      "name": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "scheduledTriggers": [
        {
          "schedule": {
            "intervalList": [
              {
                "minuteOfWeekStart": 123,
                "minuteOfWeekStop": 123
              }
            ],
            "mutable": true,
            "name": "<string>",
            "oneTimeUse": true,
            "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "strategy": "WEEKLY_REPEATING_MINUTES",
            "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
          },
          "triggerSet": [
            {
              "activity": "SOUND_LOUD",
              "faceAlertLabelSet": [
                "<string>"
              ],
              "faceAlertUnidentified": true,
              "faceAllowedLabelSet": [
                "<string>"
              ],
              "lufsThreshold": 123,
              "peopleCountThreshold": 123,
              "vehicleAlertLabelSet": [
                "<string>"
              ],
              "vehicleAlertUnidentified": true,
              "vehicleAllowedLabelSet": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "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 all policies that use a specific schedule.

​
scheduleUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing all policies that use a specific schedule, organized by policy type.

​
accessControlledDoorPolicyList
object[] | null

List of access controlled door policies using the schedule

​
audioPolicyList
object[] | null

List of audio policies using the schedule

​
cameraPolicyList
object[] | null

List of camera policies using the schedule

​
climatePolicyList
object[] | null

List of climate policies using the schedule

​
doorPolicyList
object[] | null

List of door sensor policies using the schedule

​
error
boolean | null
​
errorMsg
string | null
​
occupancyPolicyList
object[] | null

List of occupancy policies using the schedule

​
proximityPolicyList
object[] | null

List of proximity policies using the schedule

​
videoIntercomPolicyList
object[] | null

List of video intercom policies using the schedule

​
warningMsg
string | null