Event Webservice

Share multiple clips in a single page

Share multiple clips in a single page

post/api/event/createSharedClipGroupV3

Request

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

expirationTimeSecsinteger nullable

Expiration time in seconds for the shared clip group

plaintextPasswordstring nullable

Optional password for accessing the shared clip group

titlestring nullable

Title for the shared clip group

Example request

{
  "expirationTimeSecs": 86400,
  "plaintextPassword": "mypassword123",
  "title": "Security Incident - Main Entrance",
  "uuids": [
    {
      "alertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "eventUuid": "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
shareUrlstring nullable

URL for accessing the shared clip group

uuidstring RUUID nullable

base 64 (url-safe) uuid string

warningMsgstring nullable

Example response

{
  "shareUrl": "https://share.rhombus.com/clips/abc123",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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