Parameters (filters) for selecting values from the category directory (object XSearchCategories)

JSON:

{
  "all": true,
  "withSubCategories": true
}

Table 1 - Parameters description of object XSearchCategories

Parameter

Type 1

Format

Description

Object XSearchCategories

all

O

boolean

the whole directory

withSubCategories

O

boolean

including child subcategories

ids

O

List <Long>

by list of identifiers (array of values)

name

O

String

by name

names

O

List <String>

by list of names (array of values)


1

The definition of an abbreviated notation:

  • M (mandatory);

  • O (optional).