Guardrails

Output representation of each guardrail that includes information to manage system thresholds and notifications in BRE components.

JSON Sample

1{
2  "guardrails": {
3    "name": "MaxProcessLimit",
4    "guardrailType": "RateLimit",
5    "limitValue": "100",
6    "currentValue": "50",
7    "notificationSupported": true
8  }
9}
Property NameTypeDescriptionFilter Group and VersionAvailable Version
currentValueStringCurrent value of the guardrail.Small, 63.063.0
Guardrail Current ValueResource type and the row-level current values of the guardrail. For future use only.Small, 63.063.0
guardrail​TypeGuardrail Type (enumeration of type string)Type of guardrail.
Valid values are:
  • RateLimit
  • OrgValueLimit
Small, 63.063.0
limitValueStringDefault or configured value of the given guardrailSmall, 63.063.0
StringMaximum value of the given guardrail. For future use only.Small, 63.063.0
multiValueBooleanSpecifies details if the current values are determined by an org level or aggregation of row levels.Small, 63.063.0
nameStringName of the guardrail.Small, 63.063.0
notification​SupportedBooleanIndicates whether the guardrail supports notifications (true) or not (false).Small, 63.063.0