Scene Query

Selective update prompt configuration

Selectively update a scene query configuration

POST/api/scenequery/selectiveUpdatePromptConfiguration

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the write scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request object for selectively updating a prompt configuration.

activeboolean | nullbody

Optional active status for the prompt configuration

cameraConfigurationsobject[] | nullbody

List of camera configurations for the prompt

Show child attributes

cameraUuidstring<DeviceFacetUuid> | nullbody

RUUID with optional appended facet information

Example: "AAAAAAAAAAAAAAAAAAAAAA.v0"

checkConditionOverrideobject | nullbody

Show child attributes

operatorenum<string>body

Available options: GT, LT, LTE, GTE, EQ, CONTAINS

valuestring | nullbody

exampleImagesobject[] | nullbody

Show child attributes

imagestring | nullbody

imageUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

labelstring | nullbody

promptExtensionstring | nullbody

promptOverridestring | nullbody

regionobjectbody

Show child attributes

coordinatesobject[] | nullbody

Show child attributes

xnumber<float> | nullbody

ynumber<float> | nullbody

scheduledActionsobject[] | nullbody

Show child attributes

actionobjectbody

The action to take when this lockdown rule is triggered.

Show child attributes

activateLocationLockdownobjectbody

Show child attributes

locationLockdownPlanUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

alertActionboolean | nullbody

audioPlaybackActionsobject[] | nullbody

Show child attributes

audioClipUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

audioGatewaysstring<RUUID>[] | nullbody

loopDurationSecinteger<int32> | nullbody

playCountinteger<int32> | nullbody

sourceenum<string>body

Available options: ON_DEVICE, STREAM

cancelLoopingAudioPlaybackActionobjectbody

Show child attributes

_audioDevicesstring<DeviceFacetUuid>[] | nullbody

audioDevicesstring<DeviceFacetUuid>[] | nullbody

changeComponentCompositeAccessStateActionsobject[] | nullbody

Show child attributes

accessStateenum<string>body

Available options: UNLOCKED, ACCESS_CONTROLLED

alwaysCreateOverrideIfNoFirstInboolean | nullbody

componentCompositeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

expirationStrategyenum<string>body

Available options: TIME_DELAY, TIME_OF_DAY_LOCAL, NONE

expireTimeDelaySecondsinteger<int64> | nullbody

expireTimeOfDayLocalSecondsinteger<int64> | nullbody

useFirstInRulesIfPossibleboolean | nullbody

versioninteger<int32> | nullbody

connectAudioDeviceToMobileAppActionobjectbody

Show child attributes

audioDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceTypeenum<string>body

Available options: BLE_TRACKER, CAMERA, DOOR_SENSOR, ENVIRONMENTAL_SENSOR, OCCUPANCY_SENSOR, AUDIO_GATEWAY, EXECUTABLE, BADGE_READER, DOOR_CONTROLLER, BLE_BUTTON, IO_BOARD, ENVIRONMENTAL_GATEWAY, NVR, ROBOT, UNKNOWN

doorUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

targetDoorStationUuidsstring<RUUID>[] | nullbody

targetUserUuidsstring<RUUID>[] | nullbody

connectAudioDeviceToPhoneNumberActionobjectbody

Show child attributes

audioDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

deviceTypeenum<string>body

doorUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

optionalGreetingstring | nullbody

phoneNumberstring | nullbody

createAlarmActionobjectbody

Show child attributes

attachMediaToActiveAlarmboolean | nullbody

entryInstructionsstring | nullbody

exclusiveEmergencyContactboolean | nullbody

exclusiveEntryInstructionsboolean | nullbody

locationUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

mediaDeviceUuidsstring<DeviceFacetUuid>[] | nullbody

onsiteEmergencyContactobjectbody

Show child attributes

namestring | nullbodyrequired

The name of the emergency contact.

phoneNumberstring | nullbodyrequired

The phone number for this emergency contact.

reasonstring | nullbody

sirenSettingsobjectbody

Show child attributes

audioGatewaysstring<RUUID>[] | nullbodyrequired

UUIDs of audio gateways used to play this siren.

clipUuidstring<RUUID> | nullbodyrequired

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

durationSecondsinteger<int32> | nullbody

The duration (in seconds) to loop the clip audio for the siren.

playCountinteger<int32> | nullbody

The number of times to play the clip audio for the siren.

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | nullbody

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

triggerTypeenum<string>body

Available options: PANIC_BUTTON, ALARM_INTEGRATION

customActionsobject[] | nullbody

Show child attributes

headersobject | nullbody

pathstring | nullbody

customLLMActionsobject[] | nullbody

Show child attributes

deviceActivityEventsobject | nullbody

Show child attributes

activitiesenum<string>[] | nullbody

boundingBoxesobject[] | nullbody

Show child attributes

activityenum<string>body

Available options: SOUND_LOUD, SOUND_GUN_SHOT, TAMPER, VISUAL_TAMPER, MOTION_TAMPER, MOTION, MOTION_HUMAN, MOTION_CAR, MOTION_ANIMAL, MOTION_PACKAGE, PACKAGE_ARRIVED, PACKAGE_DEPARTED, FACE, FACE_IDENTIFIED, FACE_UNIDENTIFIED, FACE_BLACKLISTED, FACE_ALERT, POSE_ANOMALOUS, POSE_FALL, LICENSEPLATE, LICENSEPLATE_IDENTIFIED, LICENSEPLATE_UNIDENTIFIED, LICENSEPLATE_ALERT, LICENSEPLATE_BLACKLISTED, LICENSEPLATE_TRUSTED, PEOPLECOUNT_HIGH, PEOPLECOUNT_HIGH_RESET, PEOPLECOUNT_LOW, PEOPLECOUNT_LOW_RESET, HUMAN_ENTER, HUMAN_EXIT, CAR_ENTER, CAR_EXIT, TEMPERATURE_EXCEEDED_HIGH, TEMPERATURE_EXCEEDED_LOW, HUMIDITY_EXCEEDED_HIGH, HUMIDITY_EXCEEDED_LOW, PM25_EXCEEDED_HIGH, TVOC_EXCEEDED_HIGH, ETOH_EXCEEDED_HIGH, IAQ_EXCEEDED_HIGH, CO2_EXCEEDED_HIGH, CO2_EXCEEDED_LOW, PROBE_TEMPERATURE_EXCEEDED_HIGH, PROBE_TEMPERATURE_EXCEEDED_LOW, PROBE_DISCONNECTED, PROBE_CONNECTED, HEAT_INDEX_EXCEEDED_HIGH, PRESSURE_EXCEEDED_HIGH, PRESSURE_EXCEEDED_LOW, PM10_EXCEEDED_HIGH, PM40_EXCEEDED_HIGH, PM100_EXCEEDED_HIGH, VOC_IDX_EXCEEDED_HIGH, NOX_IDX_EXCEEDED_HIGH, FORMALDEHYDE_EXCEEDED_HIGH, CARBON_MONOXIDE_EXCEEDED_HIGH, AQI_EXCEEDED_HIGH, DOOR_AJAR, DOOR_OPENED, DOOR_CLOSED, BUTTON_SINGLE_PRESSED, BUTTON_DOUBLE_PRESSED, BUTTON_LONG_PRESSED, TAG_ARRIVED, TAG_DEPARTED, TAG_MOVED, TAG_POSITIONING_CHANGED, TAG_BOUNDARY_INGRESS, TAG_BOUNDARY_EGRESS, TAG_PANIC, BADGE_AUTHORIZED, BADGE_UNAUTHORIZED, BADGE_UNAUTHORIZED_V2, BADGE_AJAR, BADGE_MANUAL, BADGE_FORCED_OPEN, BADGE_LOCKDOWN, BADGE_REQUEST_TO_EXIT, BADGE_DURESS, BADGE_SECURITY_BREACH, BADGE_TAMPER, BADGE_FACE_MISMATCH, POS_ORDER, GUN_DETECT_EVENT, IOT_SOUND_AGGRESSION, IOT_SOUND_HELP, IOT_AIR_CO, IOT_AIR_CO2, IOT_AIR_MASKING, IOT_AIR_THC, IOT_AIR_VAPE, IOT_AIR_VOC, IOT_AIR_TEMP, IOT_TAMPER, IOT_GUNSHOT, IOT_BUTTON_SINGLE_CLICK, IOT_BUTTON_DOUBLE_CLICK, IOT_BUTTON_HOLD, IOT_PANIC_BUTTON_TRIGGERED, AUDIO_SOUND_SIGNIFICANT, AUDIO_SOUND_LOUD, AUDIO_SOUND_ABUSIVE, AUDIO_SOUND_GREETING, AUDIO_SOUND_HELP, AUDIO_SOUND_GUN, AUDIO_SOUND_GLASS_BREAK, AUDIO_SOUND_ALARM_SMOKE_FIRE, AUDIO_SOUND_ALARM_CARBON_MONOXIDE, AUDIO_SOUND_SIREN, CLIMATE_VOC, CLIMATE_VAPE, CLIMATE_SMOKE, CLIMATE_THC, CLIMATE_CO2, CLIMATE_ETOH, CLIMATE_PM25, CLIMATE_IAQ, CLIMATE_LEAK, SOUND_AGGRESSION, SOUND_HELP, AIR_CO, AIR_CO2, AIR_MASKING, AIR_THC, AIR_VAPE, AIR_VOC, MASK_MISSING, HELMET_MISSING, GLOVES_MISSING, PIR_OCCUPIED, PIR_MOVEMENT, PIR_VACANT, CUSTOM, VISITOR_ARRIVED, VISITOR_DEPARTED, AC_DR_CONNECTED, AC_DR_DISCONNECTED, AC_DPI_DOOR_OPEN, AC_DPI_DOOR_CLOSED, AC_DPI_DOOR_AJAR, AC_DPI_DOOR_FORCED_OPEN, AC_DSR_UNLOCKED, AC_DSR_LOCKED, AC_DB_TRIGGERED, AC_PANIC_BUTTON_TRIGGERED, AC_REMOTE_UNLOCK, AC_BADGE_AUTHORIZED, AC_BADGE_UNAUTHORIZED, AC_BADGE_FACE_MISMATCH, AC_LOCKDOWN_ACTIVATED, AC_LOCKDOWN_DEACTIVATED, AC_LOCKDOWN_PLAN_SWITCHED, AC_TAMPER_PROX, AC_TAMPER_ACCEL, AC_TAMPER_SWITCH, AC_GR_ACTIVE, AC_GR_INACTIVE, AC_GI_ACTIVE, AC_GI_INACTIVE, AC_REX_ACTIVE, AC_REX_INACTIVE, AC_APERIO_DEVICE_DISCONNECTED, AC_APERIO_DEVICE_CONNECTED, AC_APERIO_DEVICE_REBOOT, AC_APERIO_DEVICE_TAMPER, AC_APERIO_LOW_BATTERY, AC_APERIO_FLAT_BATTERY, AC_APERIO_OK_BATTERY, AC_SCHLAGE_GW_DISCONNECTED, AC_SCHLAGE_GW_CONNECTED, AC_SCHLAGE_APM_DISCONNECTED, AC_SCHLAGE_APM_CONNECTED, AC_SCHLAGE_LOW_BATTERY, AC_SCHLAGE_CRITICAL_BATTERY, AC_SCHLAGE_OK_BATTERY, POWER_SWITCH_BATTERY, POWER_SWITCH_PRIMARY, AI_SEARCH_MATCH, AI_SEARCH_MATCH_PERSON_SMOKING, AI_SEARCH_MATCH_PERSON_ON_PHONE, AI_SEARCH_MATCH_PERSON_FALLING, CUSTOM_LLM_BOOLEAN_TRUE, CUSTOM_LLM_BOOLEAN_FALSE, CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW, CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH, ALM_AUTHORITIES_CONTACTED, ALM_MONITORING_ENABLED, ALM_MONITORING_DISABLED, ALM_MONITORING_SETTINGS_CHANGE, ALM_THREAT_CASE_CLOSED, ALM_THREAT_DETECTED, ALM_MONITORING_EVENT_DETECTED, ROBOT_DOG_DETECTED, ROBOT_ARRIVED_AT_WAYPOINT, ROBOT_ARRIVED_AT_POSE, ROBOT_WAITING_AT_POSE, ROBOT_MANUAL_CMD_VEL, ROBOT_MANUAL_ACTION, ROBOT_MANUAL_POSTURE, ROBOT_NAVIGATE_TO_POSE_START, ROBOT_NAVIGATE_TO_POSE_END, ROBOT_NAVIGATE_TO_HOME_START, ROBOT_NAVIGATE_TO_HOME_END, ROBOT_NAVIGATE_TO_WAYPOINT_START, ROBOT_NAVIGATE_TO_WAYPOINT_END, ROBOT_ROUTE_RUN_START, ROBOT_ROUTE_RUN_END, ROBOT_LOW_BATTERY_DOCKING, ROBOT_IDLE_DOCKING, ROBOT_EMERGENCY, LOITER_HUMAN, INACTIVITY_HUMAN, INACTIVITY_CAR, GROUP_ENTRY, ONGUARD_BADGE_AUTHORIZED, ONGUARD_BADGE_ANOMALY, ONGUARD_NO_ENTRY_MADE, ELEMENTS_BADGE_AUTHORIZED, ELEMENTS_BADGE_ANOMALY, ELEMENTS_NO_ENTRY_MADE, NETBOX_BADGE_AUTHORIZED, NETBOX_BADGE_ANOMALY, NETBOX_NO_ENTRY_MADE, THERMAL_TEMPERATURE_ALARM, THERMAL_TEMPERATURE_WARNING, THERMAL_FIRE_DETECTED, THERMAL_SMOKING_DETECTED, THERMAL_FIRE_VERIFIED, THERMAL_HEAT_NO_THREAT, THERMAL_VISUAL_HOTSPOT, THERMAL_VISUAL_HEAT_RISE, THERMAL_VISUAL_WARM_BODY, UNKNOWN

alertboolean | nullbody

bottominteger<int32> | nullbody

confidencenumber<float> | nullbody

croppedImageLocatorstring | nullbody

customActivityColorenum<string>body

Available options: BLUE, RED, PURPLE, TAN, ORANGE, TEAL, GRAY, BLACK

customActivityDescriptionstring | nullbody

customActivityDisplayNamestring | nullbody

dwellingboolean | nullbody

faceNamestring | nullbody

inMotionboolean | nullbody

keypointsV2object | nullbody

Show child attributes

xinteger<int32> | nullbody

yinteger<int32> | nullbody

leftinteger<int32> | nullbody

licensePlatestring | nullbody

loudnessinteger<int32> | nullbody

objectIdinteger<int32> | nullbody

posestring | nullbody

relativeSecondnumber<float> | nullbody

rightinteger<int32> | nullbody

sensorValTypeobjectbody

Show child attributes

sensorBooleanboolean | nullbody

sensorDoublenumber<double> | nullbody

sensorLonginteger<int64> | nullbody

stableTrackIdinteger<int32> | nullbody

toastOrderIdInfoobjectbody

Show child attributes

employeeNamestring | nullbody

guidstring | nullbody

locationNamestring | nullbody

restaurantNamestring | nullbody

toastCheckInfoobjectbody

Show child attributes

totalAmountnumber<double> | nullbody

topinteger<int32> | nullbody

unidentifiedFaceIdstring | nullbody

vehicleNamestring | nullbody

durationSecinteger<int32> | nullbody

timestampMsinteger<int64> | nullbody

deviceFacetUuidsstring<DeviceFacetUuid>[] | nullbody

orgUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

promptUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

timestampMsinteger<int64> | nullbody

emailAuditLogExportActionsobject[] | nullbody

Show child attributes

includeActionsstring[] | nullbody

includeApiInvocationboolean | nullbody

lookbackCountinteger<int32> | nullbody

lookbackTypeenum<string>body

Available options: ROLLING, PREVIOUS_DAY, PREVIOUS_WEEK, PREVIOUS_MONTH

lookbackUnitenum<string>body

Available options: HOURS, DAYS, WEEKS

recipientEmailsstring[] | nullbody

timezoneIdstring | nullbody

enableDisableAudioRecordActionsobject[] | nullbody

Show child attributes

audioDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

enableboolean | nullbody

integrationCommandActionsobject[] | nullbody

Show child attributes

commandPayloadstring | nullbody

delaySecsinteger<int32> | nullbody

integrationenum<string>body

Available options: AVIGILON_ALTA, BOULEVARD, BRIVO, BUTTERFLY_MX, DEVICE_INTEGRATION, DICE, ENVOY, FLIC, GENEA, GOOGLE, HONEYWELL_ELEMENTS, GUEST_MANAGEMENT, INFORMACAST, INNER_RANGE, KISI, LUMEO, MICROSOFT_TEAMS, OMNIALERT, OPENAI, OPENTECH_ALLIANCE, PIMLOC, PLACE_OS, PRODATAKEY, SHELLY, TOAST, WEBHOOKS, ZAPIER, RAPTOR, NINEONEONE_CELLULAR, SLACK, APERIO, PAR_POS, HONEYWELL_ONGUARD, HONEYWELL_NETBOX, SIGNATURE_API, SCHLAGE, UNKNOWN

integrationNotificationActionsobject[] | nullbody

Show child attributes

integrationenum<string>body

notificationEntitystring | nullbody

notificationTargetstring | nullbody

liveNotificationActionboolean | nullbody

remoteDoorUnlockActionsobject[] | nullbody

Show child attributes

doorIdstring | nullbody

placeIdstring | nullbody

systemenum<string>body

Available options: BRIVO, OPENPATH, KISI, PLACEOS, GENEA, PDK, INNER_RANGE, RHOMBUS, HONEYWELL_ELEMENTS, UNKNOWN

robotActionsobject[] | nullbody

Show child attributes

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>body

Available options: DEPLOY, UNKNOWN

One of:

Show Deploy Robot variant

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>body

Available options: DEPLOY, UNKNOWN

mapUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

navTypeenum<string>body

Available options: ROUTE, PATROL, WAYPOINT, POSE

patrolUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

poseobjectbody

Show child attributes

orientationnumber<double>[] | nullbody

Items: 4 to 4

positionnumber<double>[] | nullbody

Items: 3 to 3

routeUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

waypointUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show No Op variant

deviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>body

Available options: DEPLOY, UNKNOWN

thirdPartyAudioPlaybackActionobjectbody

Show child attributes

audioFileNamestring | nullbody

ipAddressstring | nullbody

loopDurationSecinteger<int32> | nullbody

passwordstring | nullbody

playCountinteger<int32> | nullbody

proxyDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | nullbody

thirdPartyStrobeSirenActionobjectbody

Show child attributes

durationSecinteger<int32> | nullbody

ipAddressstring | nullbody

lightColorsstring[] | nullbody

lightIntensityinteger<int32> | nullbody

lightPatternstring | nullbody

lightSpeedinteger<int32> | nullbody

passwordstring | nullbody

profileNamestring | nullbody

proxyDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

sirenIntensityinteger<int32> | nullbody

sirenPatternstring | nullbody

usernamestring | nullbody

triggerComponentRelayActionsobject[] | nullbody

Show child attributes

componentUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

outputTypeenum<string>body

Available options: TRANSIENT, STEADY

overrideRelayDurationMsinteger<int32> | nullbody

overrideRelayDurationSecinteger<int32> | nullbody

ownerDeviceUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

stateenum<string>body

Available options: ACTIVE, INACTIVE, UNKNOWN

versioninteger<int32> | nullbody

webhookActionsobject[] | nullbody

Show child attributes

headersobject | nullbody

oauthClientIdstring | nullbody

oauthClientSecretstring | nullbody

oauthGrantTypestring | nullbody

oauthScopestring | nullbody

oauthUrlstring | nullbody

webhookSecretstring | nullbody

webhookUrlstring | nullbody

backoffMinutesinteger<int32> | nullbody

backoffSecondsinteger<int32> | nullbody

ruleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

scheduleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

checkConditionobject | nullbody

Show child attributes

operatorenum<string>body

Available options: GT, LT, LTE, GTE, EQ, CONTAINS

valuestring | nullbody

descriptionstring | nullbody

Optional description for the prompt configuration

minuteTriggerRateinteger<int32> | nullbody

Optional minute trigger rate for the configuration

namestring | nullbody

Optional name for the prompt configuration

orgUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

promptstring | nullbody

Optional prompt text for the configuration

promptTypeenum<string>body

Optional prompt type for the configuration

Available options: COUNT, PERCENT, BOOLEAN, TEXT

scheduleUuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

shortNamestring | nullbody

Optional short name for the prompt configuration

uuidstring<RUUID> | nullbody

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/scenequery/selectiveUpdatePromptConfiguration' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "active": true,
    "cameraConfigurations": [
      {
        "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
        "checkConditionOverride": {
          "operator": "GT",
          "value": "<string>"
        },
        "exampleImages": [
          {
            "image": "<string>",
            "imageUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "label": "<string>"
          }
        ],
        "promptExtension": "<string>",
        "promptOverride": "<string>",
        "region": {
          "coordinates": [
            {}
          ]
        },
        "scheduledActions": [
          {
            "action": {},
            "backoffMinutes": 0,
            "backoffSeconds": 0,
            "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        ]
      }
    ],
    "checkCondition": {
      "operator": "GT",
      "value": "<string>"
    },
    "description": "<string>",
    "minuteTriggerRate": 0,
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "prompt": "<string>",
    "promptType": "COUNT",
    "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "shortName": "<string>",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }'

import requests

url = "https://api2.rhombussystems.com/api/scenequery/selectiveUpdatePromptConfiguration"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "active": True,
    "cameraConfigurations": [
        {
            "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
            "checkConditionOverride": {
                "operator": "GT",
                "value": "<string>"
            },
            "exampleImages": [
                {
                    "image": "<string>",
                    "imageUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                    "label": "<string>"
                }
            ],
            "promptExtension": "<string>",
            "promptOverride": "<string>",
            "region": {
                "coordinates": [
                    {}
                ]
            },
            "scheduledActions": [
                {
                    "action": {},
                    "backoffMinutes": 0,
                    "backoffSeconds": 0,
                    "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                    "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
                }
            ]
        }
    ],
    "checkCondition": {
        "operator": "GT",
        "value": "<string>"
    },
    "description": "<string>",
    "minuteTriggerRate": 0,
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "prompt": "<string>",
    "promptType": "COUNT",
    "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "shortName": "<string>",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/scenequery/selectiveUpdatePromptConfiguration', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "active": true,
    "cameraConfigurations": [
      {
        "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
        "checkConditionOverride": {
          "operator": "GT",
          "value": "<string>"
        },
        "exampleImages": [
          {
            "image": "<string>",
            "imageUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "label": "<string>"
          }
        ],
        "promptExtension": "<string>",
        "promptOverride": "<string>",
        "region": {
          "coordinates": [
            {}
          ]
        },
        "scheduledActions": [
          {
            "action": {},
            "backoffMinutes": 0,
            "backoffSeconds": 0,
            "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
            "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
          }
        ]
      }
    ],
    "checkCondition": {
      "operator": "GT",
      "value": "<string>"
    },
    "description": "<string>",
    "minuteTriggerRate": 0,
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "prompt": "<string>",
    "promptType": "COUNT",
    "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "shortName": "<string>",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "active": true,
              "cameraConfigurations": [
                {
                  "cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
                  "checkConditionOverride": {
                    "operator": "GT",
                    "value": "<string>"
                  },
                  "exampleImages": [
                    {
                      "image": "<string>",
                      "imageUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                      "label": "<string>"
                    }
                  ],
                  "promptExtension": "<string>",
                  "promptOverride": "<string>",
                  "region": {
                    "coordinates": [
                      {}
                    ]
                  },
                  "scheduledActions": [
                    {
                      "action": {},
                      "backoffMinutes": 0,
                      "backoffSeconds": 0,
                      "ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
                      "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
                    }
                  ]
                }
              ],
              "checkCondition": {
                "operator": "GT",
                "value": "<string>"
              },
              "description": "<string>",
              "minuteTriggerRate": 0,
              "name": "<string>",
              "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "prompt": "<string>",
              "promptType": "COUNT",
              "scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
              "shortName": "<string>",
              "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/scenequery/selectiveUpdatePromptConfiguration"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

Response object for selectively updating a prompt configuration.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.