Zabbix Documentation 4.0

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


manual:api:reference_commentary

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Last revision Both sides next revision
manual:api:reference_commentary [2019/03/13 13:48]
basilgon specified default value for sortorder
manual:api:reference_commentary [2019/03/14 11:59]
basilgon sorting additive
Line 43: Line 43:
 |searchByAny ​ |boolean | If set to ''​true''​ return results that match any of the criteria given in the ''​filter''​ or ''​search''​ parameter instead of all of them.  \\ \\ Default: ''​false''​. ​ | |searchByAny ​ |boolean | If set to ''​true''​ return results that match any of the criteria given in the ''​filter''​ or ''​search''​ parameter instead of all of them.  \\ \\ Default: ''​false''​. ​ |
 |searchWildcardsEnabled ​ |boolean | If set to ''​true''​ enables the use of "​*"​ as a wildcard character in the ''​search''​ parameter. ​ \\ \\ Default: ''​false''​. | |searchWildcardsEnabled ​ |boolean | If set to ''​true''​ enables the use of "​*"​ as a wildcard character in the ''​search''​ parameter. ​ \\ \\ Default: ''​false''​. |
-|sortfield ​ |string/​array |Sort the result by the given properties. Refer to a specific API get method description for a list of properties that can be used for sorting. Macros are not expanded before sorting. ​ | +|sortfield ​ |string/​array |Sort the result by the given properties. Refer to a specific API get method description for a list of properties that can be used for sorting. Macros are not expanded before sorting.\\ \\ If the value in this field are not specified, the resulting data will be received in the general case in an unsorted order.  | 
-|sortorder ​ |string/​array |Order of sorting. If an array is passed, each value will be matched to the corresponding property given in the ''​sortfield''​ parameter.\\ \\ Possible values are: \\ ''​ASC''​ - (default) ascending; \\ ''​DESC''​ - descending. ​ |+|sortorder ​ |string/​array |Order of sorting. If an array is passed, each value will be matched to the corresponding property given in the ''​sortfield''​ parameter.\\ \\ Possible values are: \\ ''​ASC''​ - //(default)// ascending; \\ ''​DESC''​ - descending. ​ |
 |startSearch ​ |boolean |The ''​search''​ parameter will compare the beginning of fields, that is, perform a ''​LIKE "​…%"''​ search instead.\\ \\ Ignored if ''​searchWildcardsEnabled''​ is set to ''​true''​. ​  | |startSearch ​ |boolean |The ''​search''​ parameter will compare the beginning of fields, that is, perform a ''​LIKE "​…%"''​ search instead.\\ \\ Ignored if ''​searchWildcardsEnabled''​ is set to ''​true''​. ​  |