Event Webservice

Get a specified saved clip with current progress

Get a specified saved clip with current progress

post/api/event/getClipWithProgress

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/event/getClipWithProgress
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

clipUuidstring RUUID nullable required

base 64 (url-safe) uuid string

Example request

{
  "clipUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "clip": {
    "accessSettings": {
      "allowedRoles": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ],
      "allowedUsers": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    },
    "currentOperation": "Processing video",
    "devicePresentationOrder": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
    "deviceUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "lastUpdatedSec": 1640995200,
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "percentComplete": 75,
    "sourceAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "userUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.