Reference Guide

4
Generic Query Parameters
Many GET methods which return a list of objects support generic query parameters for filtering, sorting,
and pagination. These methods are indicated in the API reference section but the detailed syntax is
described here.
• filter=<operator>,<valid filter column>,<value>,<value2>…
• operator is one of ( eq, co )
• where valid filter columns are listed for each supporting method in the API reference
• Examples:
– "eq,columnName,columnValue"
To include resources where columnName is columnValue.
– "eq,columnName,columnValue,columnValue2[,columnValue3…]"
To include resources where columnName is columnValue OR columnValue2.
– "eq,columnName,"
To include resources where columnName is empty.
– "eq,columnName,,columnValue[,columnValue2…]"
To include resources where columnName is empty OR columnValue.
– "co,columnName,columnValue"
To include resources where columnName contains columnValue:
• sort=[-]<valid sort column>, where valid sort columns are listed for each supporting method in the
API reference and a minus sign preceding the column name indicates descending order
• offset= <integer> default is 0
• limit= <integer> default is 50
Dates in query strings
Some of the columns that are sortable or filterable are dates such as createdDate. When using the filter
parameter with date strings, only the eq operator is valid. The format for these date strings is:
dd-MM-yyyy
example: 30-07-2015
13