Skip to main content
POST
/
api
/
event
/
getClipWithProgress
Get a specified saved clip with current progress
curl --request POST \
  --url https://api2.rhombussystems.com/api/event/getClipWithProgress \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "clip": {
    "accessSettings": {
      "allowedRoles": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "allowedUsers": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "visibility": "PRIVATE"
    },
    "alterMap": {},
    "analyzed": true,
    "byteCount": 123,
    "clipLocation": {
      "region": "<string>"
    },
    "consoleDelete": true,
    "createdAtMs": 123,
    "currentOperation": "Processing video",
    "description": "<string>",
    "devicePresentationOrder": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "deviceUuidMap": {},
    "deviceUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "durationSec": 123,
    "externalTransactionId": "<string>",
    "fisheyeMap": {},
    "integrationUploadList": [
      "AVIGILON_ALTA"
    ],
    "isMonitoringClip": true,
    "isVendorClip": true,
    "lastUpdatedSec": 1640995200,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "percentComplete": 75,
    "sendToSharedStorage": true,
    "sha256Hex": "<string>",
    "sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "status": "INITIATING",
    "thumbnailLocation": {
      "region": "<string>"
    },
    "timestampMs": 123,
    "title": "<string>",
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "videoResolution": {
      "height": 123,
      "width": 123
    }
  },
  "error": true,
  "errorMsg": "<string>",
  "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 retrieving a specific clip with progress information.

clipUuid
string<RUUID> | null
required

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing a specific clip with progress information.

clip
object

Saved clip with progress information for processing operations.

error
boolean | null
errorMsg
string | null
warningMsg
string | null