Rules Webservice

Get rule pause settings

Get the current and planned rule pause details

post/api/rules/getRulePauseSettings

Request

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

RulesGetRulePauseSettingsWSRequest required

Request object for getting rule 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
rulesPausedMapobject nullable

Map of rule UUIDs to their pause settings

warningMsgstring nullable

Changes

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