Skip to content

Get Rule Sets

GET
/v1/sandbox/{sandbox_id}/inventory-bucket-use-rule-set

Get Inventory Bucket Use Rule Sets by filters. All filters must be true for an Inventory Bucket Use Rule Sets to be returned. Requires any of permissions: sandbox:config:view, sandbox:config:edit

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Query Parameters

inventory_bucket_use_rule_set_ids

Inventory Bucket Use Rule Set IDs to filter by

Array<string>

Inventory Bucket Use Rule Set IDs to filter by

legacy_inventory_bucket_use_rule_set_ids

Legacy Inventory Bucket Use Rule Set IDs to filter by

Array<integer>

Legacy Inventory Bucket Use Rule Set IDs to filter by

name

Filter by case insensitive name

string
>= 1 characters <= 50 characters

Filter by case insensitive name

last_modified_account_ids

Filter by last modified account ID

Array<string>

Filter by last modified account ID

sort_by

Sort results by

string
Allowed values: rule_set_id legacy_inventory_bucket_use_rule_set_id name last_modified_timestamp last_modified_account_id

Sort results by

sort_order

Sort order

string
Allowed values: asc desc

Sort order

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

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

Responses

200

Successful Response

A collection of Inventory Bucket Use Rule Sets. A rule set determine how item can be used across buckets.

object
data

The Inventory Bucket Use Rule Sets.

Array<object>
default:

A collection of Inventory Bucket Use Rules.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
rules

The Inventory Bucket Use Rules by Inventory Bucket.

object
key
additional properties
Array<string>
Allowed values: free sweat none anon amazon steam psn xbox_live google twitch nintendo_switch apple nintendo epic google_play nintendo_ppid
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 the resource was created

string format: date-time
rule_set_id
required

The Inventory Bucket Use Rule Set ID.

string format: uuid
legacy_rule_set_id
required

The Legacy Inventory Bucket Use Rule Set ID.

integer
page_meta
required

The paging metadata.

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
page_size

The maximum number of elements to be returned per call

integer
default: 50 >= 1 <= 10000
total

The total number of entities.

integer

422

Validation Error

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