Parameter | Description | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
filters | Filter expression consists of multiple comparison operations related to each other by logical operators - Logical AND (; or and) and Logical OR (, or or). Each comparison operation has three parts: selector = Identified the field name of the object to filter against comparison-op = Currently supported comparison operators are listed in "Operators" table below arguments = Identifies the value(s) to be matched against the field. Multiple values are represented in parenthesis separated by comma The Example: filter=WorkCenter==EastCoast This will return all objects where the Supported operators are shown below in a table.
| ||||||||||||||||||||||
fields | Identifies the comma separated list of fields to include in the object representation in response. The fields=field-1,field-2
| ||||||||||||||||||||||
limit | Identifies the maximum number of objects to be returned. | ||||||||||||||||||||||
q | The q=<search term>::in:field-1,field-2 The The query parameter currently supports one search term, although it can be combined with the | ||||||||||||||||||||||
sort | Identifies the field name that should be used for sorting. The sort syntax is: sort=[-]field-1,[-]field-2
| ||||||||||||||||||||||
start | Identifies the number of objects to be skipped. This is used for pagination and allows skipping previously returned objects. |
General
Content
Integrations