Search Query
API's basic search query specifications which implements search over regex, etc.
Basic Query format
query: query includes following options items below for conditional select
NO
KEY
TYPE
REQUIRED
DESC
1
filter
list
β
filter out within operator
2
filter_or
list
β
filter out within operator
3
page
dict
β
set number of selected list to express pages or other reasons
4
sort
dict
β
sorting a list with given keys
5
minimal
boolean
β
display every item in search or minimize its results
6
count_only
boolean
β
display only number of items in the list
7
only
list
β
display only given items in the list
8
keyword
string
β
global search any string
{
"query": {
"filter": [],
"filter_or": [],
"page": {},
"sort": {},
"minimal": false,
"count_only": false,
"only": []
}
}{
"query": {
"filter": [
{
"key": "name",
"value": [
"stark",
"nick"
],
"operator": "in"
}
]
}
}NOTE:
filter and filter_or input simultaneously, it performs π AND π condition between them.
NO
KEY
TYPE
REQUIRED
DESC
1
key
string
β
any key that to filter out
2
value
list or any
β
3
operator
string
β
refer to operator below
Operator refers to Filter Operators
NOTE:
filter and filter_or input simultaneously, it performs π AND π condition between them.
KEY
TYPE
REQUIRED
DESC
key
string
β
any key that to filter out
value
list or any
β
operator
string
β
refer to operator below
Operator refers to Filter Operators
KEY
TYPE
REQUIRED
DESC
start
integer
β
start number
limit
integer
β
number of limit on selected
KEY
TYPE
REQUIRED
DESC
key
string
β
string sorting priority
desc
boolean
β
ascending or descending order Y/N
Key
TYPE
Required
description
minimal
boolean
β
displays only minimized summary of list
KEY
TYPE
REQUIRED
DESC
count_only
boolean
β
displays only counts on search list
KEY
TYPE
REQUIRED
DESC
only
list
β
column keys that user wants to expect on the results
Last updated
Was this helpful?