Pause alert policy for component composite

Pause alert policy for component composite

POST /api/policy/pauseAlertPolicyForComponentComposite

Pause alert policy for component composite

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/policy/pauseAlertPolicyForComponentComposite \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "componentCompositeUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "deviceUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "durationSec": 3600,
  "locationUuids": [
    "AAAAAAAAAAAAAAAAAAAAAA"
  ],
  "scheduledTimestampSec": 1640995200
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · 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.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for pausing alert policies for specified locations, devices, and components.

componentCompositeUuids · (string<RUUID> | null)[] | null

List of component composite UUIDs to pause alert policies for

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

deviceUuids · (string<RUUID> | null)[] | null

List of device UUIDs to pause alert policies for

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

durationSec · integer<int64> | null

Duration in seconds to pause alert policies

Example:

3600

locationUuids · (string<RUUID> | null)[] | null

List of location UUIDs to pause alert policies for

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

scheduledTimestampSec · integer<int64> | null

Scheduled timestamp in seconds for when to pause alert policies

Example:

1640995200

Response

200 - application/json

OK

Response object for pausing alert policies.

error · boolean | null

errorMsg · string | null

warningMsg · string | null