🚧 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/event/getSavedClipDetails \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'{
"error": true,
"errorMsg": "<string>",
"savedClip": {
"accessSettings": {
"allowedRoles": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"allowedUsers": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"visibility": "PRIVATE"
},
"alterMap": {},
"analyzed": true,
"boundingBoxes": [
{
"activity": "SOUND_LOUD",
"alert": true,
"bottom": 123,
"confidence": 123,
"croppedImageLocator": "<string>",
"customActivityColor": "BLUE",
"customActivityDescription": "<string>",
"customActivityDisplayName": "<string>",
"faceName": "<string>",
"inMotion": true,
"keypointsV2": {},
"left": 123,
"licensePlate": "<string>",
"loudness": 123,
"objectId": 123,
"pose": "<string>",
"relativeSecond": 123,
"right": 123,
"sensorValType": {
"sensorBoolean": true,
"sensorDouble": 123,
"sensorLong": 123
},
"toastOrderIdInfo": {
"employeeName": "<string>",
"guid": "<string>",
"locationName": "<string>",
"restaurantName": "<string>",
"toastCheckInfo": {
"totalAmount": 123
}
},
"top": 123,
"unidentifiedFaceId": "<string>",
"vehicleName": "<string>"
}
],
"byteCount": 123,
"clipLocation": {
"region": "<string>"
},
"consoleDelete": true,
"createdAtMs": 123,
"description": "<string>",
"devicePresentationOrder": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"deviceUuidMap": {},
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"durationSec": 123,
"externalTransactionId": "<string>",
"fisheyeMap": {},
"integrationUploadList": [
"AVIGILON_ALTA"
],
"isMonitoringClip": true,
"isVendorClip": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"seekPoints": [
{
"activity": "SOUND_LOUD",
"alert": true,
"customActivityColor": "BLUE",
"customActivityDescription": "<string>",
"customActivityDisplayName": "<string>",
"dcao": true,
"faceName": "<string>",
"id": 123,
"inMotion": true,
"licensePlate": "<string>",
"loudness": 123,
"pose": "<string>",
"relativeSecond": 123,
"sensorValType": {
"sensorBoolean": true,
"sensorDouble": 123,
"sensorLong": 123
},
"toastOrderIdInfo": {
"employeeName": "<string>",
"guid": "<string>",
"locationName": "<string>",
"restaurantName": "<string>",
"toastCheckInfo": {
"totalAmount": 123
}
},
"tu": "<string>",
"unidentifiedFaceId": "<string>",
"vehicleName": "<string>"
}
],
"sendToSharedStorage": true,
"sha256Hex": "<string>",
"sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"status": "INITIATING",
"thumbnailLocation": {
"region": "<string>"
},
"timestampMs": 123,
"title": "<string>",
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA",
"videoResolution": {
"height": 123,
"width": 123
}
},
"warningMsg": "<string>"
}Get detailed information about a saved clip, including seekpoints and bounding boxes
curl --request POST \
--url https://api2.rhombussystems.com/api/event/getSavedClipDetails \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'{
"error": true,
"errorMsg": "<string>",
"savedClip": {
"accessSettings": {
"allowedRoles": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"allowedUsers": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"visibility": "PRIVATE"
},
"alterMap": {},
"analyzed": true,
"boundingBoxes": [
{
"activity": "SOUND_LOUD",
"alert": true,
"bottom": 123,
"confidence": 123,
"croppedImageLocator": "<string>",
"customActivityColor": "BLUE",
"customActivityDescription": "<string>",
"customActivityDisplayName": "<string>",
"faceName": "<string>",
"inMotion": true,
"keypointsV2": {},
"left": 123,
"licensePlate": "<string>",
"loudness": 123,
"objectId": 123,
"pose": "<string>",
"relativeSecond": 123,
"right": 123,
"sensorValType": {
"sensorBoolean": true,
"sensorDouble": 123,
"sensorLong": 123
},
"toastOrderIdInfo": {
"employeeName": "<string>",
"guid": "<string>",
"locationName": "<string>",
"restaurantName": "<string>",
"toastCheckInfo": {
"totalAmount": 123
}
},
"top": 123,
"unidentifiedFaceId": "<string>",
"vehicleName": "<string>"
}
],
"byteCount": 123,
"clipLocation": {
"region": "<string>"
},
"consoleDelete": true,
"createdAtMs": 123,
"description": "<string>",
"devicePresentationOrder": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"deviceUuidMap": {},
"deviceUuids": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"durationSec": 123,
"externalTransactionId": "<string>",
"fisheyeMap": {},
"integrationUploadList": [
"AVIGILON_ALTA"
],
"isMonitoringClip": true,
"isVendorClip": true,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"seekPoints": [
{
"activity": "SOUND_LOUD",
"alert": true,
"customActivityColor": "BLUE",
"customActivityDescription": "<string>",
"customActivityDisplayName": "<string>",
"dcao": true,
"faceName": "<string>",
"id": 123,
"inMotion": true,
"licensePlate": "<string>",
"loudness": 123,
"pose": "<string>",
"relativeSecond": 123,
"sensorValType": {
"sensorBoolean": true,
"sensorDouble": 123,
"sensorLong": 123
},
"toastOrderIdInfo": {
"employeeName": "<string>",
"guid": "<string>",
"locationName": "<string>",
"restaurantName": "<string>",
"toastCheckInfo": {
"totalAmount": 123
}
},
"tu": "<string>",
"unidentifiedFaceId": "<string>",
"vehicleName": "<string>"
}
],
"sendToSharedStorage": true,
"sha256Hex": "<string>",
"sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"status": "INITIATING",
"thumbnailLocation": {
"region": "<string>"
},
"timestampMs": 123,
"title": "<string>",
"userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"uuid": "AAAAAAAAAAAAAAAAAAAAAA",
"videoResolution": {
"height": 123,
"width": 123
}
},
"warningMsg": "<string>"
}Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9Request object for retrieving detailed information about a saved clip.
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Was this page helpful?