Automation API Documentation: Query, Filter, Sort and Page The Automation APIs

Paging

Property	Description
$top=10	Number of records to skip. Selects only the first N elements of the set. N must be a positive integer. Specifying N limits the maximum number of elements that the server returns in the response. The default IaaS API page size is 100. If $top is left unspecified, pagination selects the first 100 elements. If you want the output to include elements beyond the first 100 elements, specify a top value greater than 100.
$skip=10	Number of records to get. Skips N elements and selects only the remaining elements starting with element N+1.
$count=true | false	If set to true, shows the total number of records. If used with a filter, shows the number of records matching the filter.
$select=fieldNameX,fieldNameY	Names the subset of properties to list in the response.
$filter=	Filters results by a predicate expression with operators such as, eq, ne, and, and or. For specialized filtering examples, see below.

Filtering Logical and Partial Match Operators

To query for the partial match of a name that starts with, ends with, or is contained within another name, the $filter options are the same for most IaaS endpoints but are different for iaas/api/projects and iaas/api/deployments endpoints.

Operator	Sample Query
equal	?$filter=fieldName eq ‘search-term’
not equal	?$filter=fieldName ne ‘search-term’
logical and	?$filter=fieldNameX eq ‘search-term’ and fieldNameY eq true
logical or	?$filter=fieldNameX eq ‘search-term’ or fieldNameY eq true
logical negation	?$filter=not startswith(fieldName, ‘search-term’)
starts with	?$filter=startswith(fieldName, ‘search-term’)
substring of	?$filter=substringof(‘search-term’, fieldName)
ends with	?$filter=endswith(fieldName, ‘search-term’)
length	?$filter=length(fieldName) eq 0
index of	?$filter=indexof(fieldName, ‘search-term”) eq 0
substring from	?$filter=substring(fieldName, 1) eq ‘ame’
substring from to	?$filter=substring(fieldName, 1, 2) eq ‘am’
to lower	?$filter=tolower(fieldName) eq ‘SEARCH-TERM’
to upper	?$filter=toupper(fieldName) eq ‘SEARCH-TERM’
concatenate	?$filter=concat(concat(fieldNameX,’,’),fieldNameY) eq ‘search,term’
trim	?$filter=trim(fieldName) eq ‘search-term’

Sorting

Operator	Sample Usage
orderBy asc	?$orderBy=fieldName asc
orderBy desc	?$orderBy=fieldName desc