🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
curl --request POST \
--url https://api2.rhombussystems.com/api/scenequery/findPromptConfigurations \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'{
"error": true,
"errorMsg": "<string>",
"promptConfigurations": [
{
"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",
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expirationStrategy": "TIME_DELAY",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": true,
"version": 123
}
],
"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"
}
],
"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": [
{
"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>",
"generateAlertForActionNewlyAddedCameras": true,
"multiImageTimeDeltasSeconds": [
123
],
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"prompt": "<string>",
"promptType": "COUNT",
"reportsEnabled": true,
"scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"shortName": "<string>",
"trigger": {
"activity": "MOTION_HUMAN",
"value": "<string>"
},
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Find all scene query configurations
curl --request POST \
--url https://api2.rhombussystems.com/api/scenequery/findPromptConfigurations \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'{
"error": true,
"errorMsg": "<string>",
"promptConfigurations": [
{
"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",
"componentCompositeUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"expirationStrategy": "TIME_DELAY",
"expireTimeDelaySeconds": 123,
"expireTimeOfDayLocalSeconds": 123,
"useFirstInRulesIfPossible": true,
"version": 123
}
],
"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"
}
],
"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": [
{
"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>",
"generateAlertForActionNewlyAddedCameras": true,
"multiImageTimeDeltasSeconds": [
123
],
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"prompt": "<string>",
"promptType": "COUNT",
"reportsEnabled": true,
"scheduleUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"shortName": "<string>",
"trigger": {
"activity": "MOTION_HUMAN",
"value": "<string>"
},
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9Request object for finding all prompt configurations.
Was this page helpful?