Skip to content

Rule

Version: 1.0.0.0 Updated: 2023-11-29 16:56:05

Summary

Documentation for the Rules Page

Rule Schema

NameTypeRequiredDescription
match_making_ruleset_idstringYesWhich ruleset this MatchMakingRule belongs to
comparison_operationobjectYesSee schema
item_idstringNoWhat item is being compared if this is an Inventory rule
rule_typeobjectYesSee schema
comparison_valueintegerYesWhat value is to be compared to
sandbox_idstringNoID of the Sandbox
last_modified_account_idstringNoAccount ID of the user who last modified the resource
last_modified_timestampstringNoTimestamp of when the resource was last modified
created_timestampstringNoTimestamp of when this resource was created
match_making_rule_idstringYesID to uniquely identify this MatchMakingRule

Comparison_operation Enum Values

ValueDescription
eqWhat comparison operation should be used when evaluating a rule
neWhat comparison operation should be used when evaluating a rule
ltWhat comparison operation should be used when evaluating a rule
leWhat comparison operation should be used when evaluating a rule
gtWhat comparison operation should be used when evaluating a rule
geWhat comparison operation should be used when evaluating a rule

Rule_type Enum Values

ValueDescription
InventoryWhat type of rule is being evaluated
LinkingSizeWhat type of rule is being evaluated