Policy Webservice

Pause alert policy for location

Pause alert policy for location

post/api/policy/pauseAlertPolicyForLocation

Request

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

componentCompositeUuidsstring[] nullable

List of component composite UUIDs to pause alert policies for

deviceUuidsstring[] nullable

List of device UUIDs to pause alert policies for

durationSecinteger nullable

Duration in seconds to pause alert policies

locationUuidsstring[] nullable

List of location UUIDs to pause alert policies for

scheduledTimestampSecinteger nullable

Scheduled timestamp in seconds for when to pause alert policies

Example request

{
  "componentCompositeUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "durationSec": 3600,
  "locationUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "scheduledTimestampSec": 1640995200
}

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.