Alert Monitoring Webservice

Cancel threat case

Cancel a threat case in alert monitoring.

post/api/alertmonitoring/cancelThreatCase

Request

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

authenticatePinboolean nullable

When true, the server authenticates the provided PIN against the threat case's zone and rejects the request if authentication fails. Expected from clients that cannot identify their caller such as alarm pads.

pinstring nullable

Optional PIN used to authenticate this request and identify the initiating user or group. Only honored when authenticatePin is true; otherwise ignored.

uuidstring RUUID nullable required

base 64 (url-safe) uuid string

Example request

{
  "uuid": "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
successboolean nullable

Indicates whether the threat case cancellation was successful

warningMsgstring nullable

Example response

{
  "success": true
}

Changes

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