Event Webservice

Save a policy alert as a saved clip

Save a policy alert as a saved clip

post/api/event/savePolicyAlertV2

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/event/savePolicyAlertV2
  • 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

alertUuidstring RUUID nullable

base 64 (url-safe) uuid string

fisheyePresentationMapobject nullable

Map of device UUIDs to dewarped view configurations for fisheye cameras

savedClipDescriptionstring nullable

Description for the saved clip

savedClipTitlestring nullable

Title for the saved clip

Example request

{
  "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "savedClipDescription": "Motion detected at main entrance",
  "savedClipTitle": "Security Incident - Motion Detected"
}

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

Changes

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