Policy Webservice

Get policy pause settings

Get the current and planned policy alert pause details

post/api/policy/getPolicyPauseSettings

Request

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

PolicyGetPolicyPauseSettingsWSRequest required

Request object for getting policy pause settings.

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
policiesPausedForComponentCompositesMapobject nullable

Map of component composite UUIDs to their paused policy scheduled intervals

policiesPausedForDevicesMapobject nullable

Map of device UUIDs to their paused policy scheduled intervals

policiesPausedForLocationsMapobject nullable

Map of location UUIDs to their paused policy scheduled intervals

warningMsgstring nullable

Changes

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