Rules Webservice

Pause rule

Pause rule

post/api/rules/pauseRule

Request

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

durationSecinteger nullable

Duration to pause the rule in seconds

ruleUuidstring RUUID nullable

base 64 (url-safe) uuid string

scheduledTimestampSecinteger nullable

Scheduled timestamp in seconds when the pause should take effect

Example request

{
  "durationSec": 3600,
  "ruleUuid": "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.