Get list of saved clips matching the external transaction id

Get list of saved clips matching the external transaction id

POST /api/event/getSavedClipsByExternalTransactionId

Get list of saved clips matching the external transaction id

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/event/getSavedClipsByExternalTransactionId \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "externalTransactionId": "txn_123456789"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "savedClips": [
    {
      "accessSettings": {
        "allowedRoles": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ],
        "allowedUsers": [
          "AAAAAAAAAAAAAAAAAAAAAA"
        ]
      },
      "alterMap": {},
      "analyzed": true,
      "byteCount": 123,
      "clipLocation": {
        "region": "<string>"
      },
      "clipLocationV2": "<string>",
      "consoleDelete": true,
      "createdAtMs": 123,
      "description": "<string>",
      "deviceIntervalMap": {},
      "devicePresentationOrder": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
      "deviceUuidMap": {},
      "deviceUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "durationSec": 123,
      "externalTransactionId": "<string>",
      "fisheyeMap": {},
      "integrationUploadList": [],
      "isMonitoringClip": true,
      "isVendorClip": true,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "sendToSharedStorage": true,
      "sha256Hex": "<string>",
      "sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "thumbnailLocation": {
        "region": "<string>"
      },
      "thumbnailLocationV2": "<string>",
      "timestampMs": 123,
      "title": "<string>",
      "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "videoResolution": {
        "height": 123,
        "width": 123
      }
    }
  ],
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

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

Headers

x-auth-scheme · enum<string> · default: api-token · required

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.

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

Body

application/json

Request object for retrieving saved clips by external transaction ID.

externalTransactionId · string | null

External transaction ID to search for saved clips

Example:

"txn_123456789"

Response

200 - application/json

OK

Response object containing saved clips by external transaction ID.

error · boolean | null

errorMsg · string | null

savedClips · object[] | null

List of saved clips matching the external transaction ID

Show child attributes

warningMsg · string | null