RuleEvaluation Parent topic

Parameter
Data Type
Description
Required?
ruleEvaluation
Container
The container for a list of rule evaluation results of a given key request.
Property type: Element
Yes
ruleEvaluation.id
String
The GUID of the security rule.
Property type: Attribute
Yes
ruleEvaluation.name
String
The name of the rule.
Property type: Attribute
Yes
ruleEvaluation.href
String
The callback URL to obtain information about this rule.
Property type: Attribute
Yes
ruleEvaluation.version
Double
The API version.
Property type: Attribute
No
ruleEvaluation.description
String
The description of the rule.
Property type: Element
No
ruleEvaluation.ruleEvaluationCategory
Container
The rule evaluation category.
Property type: Element
No
ruleEvaluationCategory.name
String
The name of the rule evaluation category.
Property type: Attribute
Yes
ruleEvaluationCategory.type
String
The type of rule evaluation category.
Property type: Attribute
Yes
ruleEvaluation.ruleEvaluationData
Container
The container for a rule evaluation result of a key request.
Property type: Element
No
ruleEvaluationData.success
Enumeration
The rule evaluation result.
Property type: Attribute
Valid values:
  • Passed
  • Failed
  • Info
No
ruleEvaluationData.evaluator
Enumeration
The conditional operator that determines how the security rule searches.
Property type: Attribute
Valid values:
  • lessThan
  • greaterThan
  • equal
  • notequal
  • equalLessThan
  • equalGreaterThan
  • information
  • Has
  • NotHave
  • Containing
  • NotContaining
Yes
ruleEvaluationData.dataType
Enumeration
The security rule data type.
Property type: Attribute
Valid values:
  • Text: a text string.
  • Numeric: a number string.
  • Date: a date in the format "yyyy-MM-dd".
  • DateTime: a date and time in the format "yyyy-MM-ddThh:mm:ss.sss, UTC".
  • TimeSpan: a duration of time.
  • IPAddress: an Internet Protocol version 4 (IPv4) address.
  • IPv6Address: an Internet Protocol version 6 (IPv6) address.
  • Version: a version number.
  • Port: a port number.
  • Path: a file path.
Yes
ruleEvaluationData.expected
String
The expected value of the rule evaluation.
Property type: Element
Yes
ruleEvaluationData.actual
String
The actual value of the rule evaluation.
Property type: Element
Yes