Skip to content

Get Rules In Ruleset

GET
/v1/sandbox/{sandbox_id}/match-making-ruleset/{match_making_ruleset_id}/rules

Get specific MatchMakingRuleset rules in a sandbox

Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

match_making_ruleset_id
required
string format: uuid
sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

page_size

The maximum number of elements to be returned per call

integer
default: 50 >= 1 <= 10000

The maximum number of elements to be returned per call

cursor

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
default: 0 >= 1 characters <= 128 characters

Cursor to designate where you are in iterating through values. Start with '0', and pass this on subsequent calls to continue iteration

Responses

200

Successful Response

object
cursor
required

Cursor to designate where you are in iterating through values. Start with ‘0’, and pass this on subsequent calls to continue iteration

string
>= 1 characters <= 128 characters
rules

List of MatchMakingRules

Array<object>
default:
object
match_making_ruleset_id
required

Which ruleset this MatchMakingRule belongs to

string format: uuid
comparison_operation
required

Which comparison operator is used when evaluating the rule

string
Allowed values: eq ne lt le gt ge
item_id

What item is being compared if this is an Inventory rule

string format: uuid
rule_type
required

What type of rule this is (determines what types of values are being compared

string
Allowed values: Inventory LinkingSize
comparison_value
required

What value is to be compared to

integer
sandbox_id

ID of the Sandbox

string format: uuid
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when this resource was created

string format: date-time
match_making_rule_id
required

ID to uniquely identify this MatchMakingRule

string format: uuid

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string