Common REST API elements
You use connectors and operators to build query segments that filter on matching conditions and values.
Connectors
Connector | Description |
---|---|
and |
Add all clauses with an and concatenator |
or |
Add all clauses with an or concatenator |
Parameters
Parameter | Description |
---|---|
countSwitch |
Specifies whether the query returns the requested data, the number of
retrieved rows, or both. The operator can have the following values:
|
Operators
Operator | Description | Applicable to |
---|---|---|
= |
Equal to. | |
!= |
Not equal to. | |
< |
Less than. | Numeric and date fields only. |
<= |
Less than or equal to. | Numeric and date fields only. |
> |
Greater than. | Numeric and date fields only. |
>= |
Greater than or equal to. | Numeric and date fields only. |
last |
Relative period of time in the past (for example, last 7 days). | Date and time fields only. |
next |
Relative period of time in the future (for example, next 7 days). | Date and time fields only. |
starting |
Relative period of time starting in the past or in the future (for example, 7 days ago, or 7 days ahead) and lasting until infinity. For syntax, see Relative date and time operators. | Date and time fields only. |
ending |
Relative period of time ending in the past or in the future (for example, 7 days ago, or 7 days ahead) and including all data until this point. For syntax, see Relative date and time operators. | Date and time fields only. |
begins_with |
String begins with the specified value. | String fields only. |
not_begins_with |
String does not begin with the specified value. | String fields only. |
contains |
String contains the specified value. | String fields only. |
not_contains |
String does not contain the specified value. | String fields only. |
ends_with |
String ends with the specified value. | String fields only. |
not_ends_with |
String does not end with the specified value. | String fields only. |
is_empty |
Column does not contain any value. Example:
|
Selected columns only. |
is_not_empty |
Column contains a value. Example:
|
Selected columns only. |
Syntax of relative date and time operators
These operators can be used for all columns that use the date and time format.
Operator | Syntax |
---|---|
|
Px[D|W|M|Y] where x is a number in the 1-999 range, and D,
W, M, or Y is a designator that represents days, weeks, months, or years respectively. For example:
|
|
[-|+]Px[D|W|M|Y] where x is a number in the 1-999 range,
-/+ stands for ago or ahead, and D, W, M, or Y is a designator that represents days, weeks, months,
or years respectively. For example:
|
Response elements for GET
requests
Element | Description |
---|---|
total |
Number of all records that meet query parameter. The number of returned
records might be smaller, for example if you use the limit parameter. |
rows |
Records that are returned by the query. |