Event Webservice

Selectively update a saved clip

Selectively updates a saved clip

post/api/event/updateSavedClip

Request

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

descriptionstring nullable

Updated description for the saved clip

savedClipUuidstring RUUID nullable required

base 64 (url-safe) uuid string

titlestring nullable

Updated title for the saved clip

Example request

{
  "accessSettings": {
    "allowedRoles": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "allowedUsers": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  },
  "description": "Updated description of the security incident",
  "savedClipUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "title": "Updated Security Incident"
}

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.