curl --request POST \
--url https://api2.rhombussystems.com/api/scenequery/selectiveUpdatePromptConfiguration \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"active": true,
"cameraConfigurations": [
{
"cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"checkConditionOverride": {
"operator": "GT",
"value": "<string>"
},
"exampleImages": [
{
"image": "<string>",
"label": "<string>"
}
],
"promptExtension": "<string>",
"promptOverride": "<string>",
"region": {
"coordinates": [
{
"x": 123,
"y": 123
}
]
},
"scheduledActions": [
{
"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
}
],
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceType": "BLE_TRACKER",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"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"
}
],
"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>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"outputType": "TRANSIENT",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"state": "ACTIVE"
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookUrl": "<string>"
}
]
},
"backoffMinutes": 123,
"backoffSeconds": 123,
"ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
]
}
],
"checkCondition": {
"operator": "GT",
"value": "<string>"
},
"description": "<string>",
"minuteTriggerRate": 123,
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"prompt": "<string>",
"promptType": "COUNT",
"scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"shortName": "<string>",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Selectively update a scene query configuration
curl --request POST \
--url https://api2.rhombussystems.com/api/scenequery/selectiveUpdatePromptConfiguration \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"active": true,
"cameraConfigurations": [
{
"cameraUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"checkConditionOverride": {
"operator": "GT",
"value": "<string>"
},
"exampleImages": [
{
"image": "<string>",
"label": "<string>"
}
],
"promptExtension": "<string>",
"promptOverride": "<string>",
"region": {
"coordinates": [
{
"x": 123,
"y": 123
}
]
},
"scheduledActions": [
{
"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
}
],
"connectAudioDeviceToPhoneNumberAction": {
"audioDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"deviceType": "BLE_TRACKER",
"doorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"optionalGreeting": "<string>",
"phoneNumber": "<string>"
},
"customActions": [
{
"headers": {},
"path": "<string>"
}
],
"customLLMActions": [
{
"deviceActivityEvents": {},
"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"
}
],
"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>"
},
"triggerComponentRelayActions": [
{
"componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"outputType": "TRANSIENT",
"overrideRelayDurationMs": 123,
"overrideRelayDurationSec": 123,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"state": "ACTIVE"
}
],
"webhookActions": [
{
"headers": {},
"oauthClientId": "<string>",
"oauthClientSecret": "<string>",
"oauthGrantType": "<string>",
"oauthScope": "<string>",
"oauthUrl": "<string>",
"webhookUrl": "<string>"
}
]
},
"backoffMinutes": 123,
"backoffSeconds": 123,
"ruleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
]
}
],
"checkCondition": {
"operator": "GT",
"value": "<string>"
},
"description": "<string>",
"minuteTriggerRate": 123,
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"prompt": "<string>",
"promptType": "COUNT",
"scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"shortName": "<string>",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'{
"error": true,
"errorMsg": "<string>",
"warningMsg": "<string>"
}Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
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.
api-token, api, partner-api-token, partner-api Request object for selectively updating a prompt configuration.
Optional active status for the prompt configuration
List of camera configurations for the prompt
Show child attributes
Show child attributes
Optional description for the prompt configuration
Optional minute trigger rate for the configuration
Optional name for the prompt configuration
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Optional prompt text for the configuration
Optional prompt type for the configuration
COUNT, PERCENT, BOOLEAN, TEXT base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Optional short name for the prompt configuration
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Was this page helpful?