Rules

Get rule details

Returns the details of a rule.

get/ruleSets/{ruleSetId}/rules/{rid}

Request

  • Base URL: https://example.com/businessRules
  • URL: https://example.com/businessRules/ruleSets/{ruleSetId}/rules/{rid}
  • Auth: none declared

Path parameters

ruleSetIdstring required

The rule set ID.

ridstring required

The rule ID.

Response

The request succeeded.

idstring

The system-assigned unique ID for this object

namestring required

The name of the rule. Rule names must be unique within a rule set.

descriptionstring

The rule description

createdBystring

The user who created the rule.

creationTimeStampstring date-time

The date and time that the rule was created.

modifiedBystring

The userId of the authenticated user who last updated the rule.

modifiedTimeStampstring date-time

The date and time that the rule was last modified.

conditional'if' | 'elseif' | 'or' | 'ref' enumeration required

Determines how the rule is related to this preceding rule. By default all rules are considered 'if' based which means that there logic is executed regardless of the how other rules within the rule set evaluate. However if a user chooses to use 'elseif' or 'or' the rule is only evaluated if the previous rule evaluates to 'false'. In the case of 'or' all actions are determined by the previous if/elseif in the set with actions. If a rule is a reference to a common rule, its conditional is set to 'ref'.

ruleFiredTrackingEnabledboolean required

Set to true if you want during executions of this rule for rule fired tracking information to be recorded. False if this rule should not have tracking turned on.

status'valid' | 'error' enumeration

The validation status of the rule. This is set to valid if no conditions or actions have validation errors. Its set to false if there are any validation errors across all its conditions and actions.

commonRuleSetIdstring

The unique id of the common ruleset that this rules references

commonRuleSetVersionIdstring

The unique id of the revision of the common ruleset tat this rule references

versioninteger

This media type's schema version number. This representation is version 3.

Example response

{
  "name": "Age Requirements",
  "conditional": "if",
  "ruleFiredTrackingEnabled": true
}

Changes

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