Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

ParameterDescription
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:
comparison = selector, comparison-op, arguments;

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 filter parameter is used to quickly reduce the result set based on the field values provided. Although the filter is case-insensitive it does preform an exact match.

Example:

filter=WorkCenter==EastCoast

This will return all objects where the WorkCenter field has a value of EastCoast

Supported operators are shown below in a table.

OperatorsDescription
"=="Equals
"=ne=" or "!="Not equals
"=gt=“ or “>"greater than
"=ge=" or “>="greater than or equals to
"=lt=“ or “<"less than
"=le=" or “<="less than or equals to
“=in="In
“=out="Not in
";” or “and"Logical AND
",” or “or"Logical OR
fields

Identifies the comma separated list of fields to include in the object representation in response.

The fields parameter syntax is:

fields=field-1,field-2
  • field-1 = The field name in the object
limit

Identifies the maximum number of objects to be returned.

q

The q parameter syntax is:

q=<search term>::in:field-1,field-2

The q (query) parameter supports partial term matches across multiple fields. For example, a search_term of Joh will match John, John's, Johansson, Johansen.

The query parameter currently supports one search term, although it can be combined with the filter parameter.

sort

Identifies the field name that should be used for sorting.

The sort syntax is:

sort=[-]field-1,[-]field-2
  • field-1 = The field name to sort against
  • [ - ] = Optional value that identifies the field is to be sorted in descending order
startIdentifies the number of objects to be skipped. This is used for pagination and allows skipping previously returned objects.
  • No labels