Search (Query Structure)

An optional parameter query string may be appended to URLs to refine the search. There are five &-separated parameters that can be used in any order:

Copy code
<URL>?fields=FIELDS&query={QUERY}&order-by={SORT}&page-size=PAGE_SIZE&start-index=INDEX

The query parameters usage is summarized in the table below:

Parameter Usage ExampleDescription
FIELDS

ID,
Name

Comma separated list of fields. Only these fields will be retrieved from the server.
QUERY ID[10];Name[Peter] Logical filtering query
SORT

ID[ASC)

TestID[DESC]

Sorted by id in ascending order Sorted by test id in descending order
PAGE_SIZE2000 Number of retrieved rows
START_INDEX1Starting index