ru:manual:api:reference_commentary

Differences

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

Link to this comparison view

Next revision
Previous revision
Next revision Both sides next revision
ru:manual:api:reference_commentary [2015/12/26 23:21]
dotneft created
ru:manual:api:reference_commentary [2016/12/06 13:16]
dotneft
Line 35: Line 35:
 |filter ​ |object |Возвращать только те результаты,​ которые в точности совпадают с заданным фильтром.\\ \\ Принимает массив,​ где ключи являются именами свойств и значения,​ либо одно значение,​ либо массив значений соответствий. \\ \\ Не работает с ''​text''​ полями. | |filter ​ |object |Возвращать только те результаты,​ которые в точности совпадают с заданным фильтром.\\ \\ Принимает массив,​ где ключи являются именами свойств и значения,​ либо одно значение,​ либо массив значений соответствий. \\ \\ Не работает с ''​text''​ полями. |
 |limit ​ |integer |Ограничение количества возвращаемых записей. ​ | |limit ​ |integer |Ограничение количества возвращаемых записей. ​ |
-|nodeids ​ |string/​array |Возвращает объекты,​ которые принадлежат заданным нодам. | 
 |output ​ |query |Свойства возвращаемых объектов. \\ \\ Default: ''​extend''​. ​ | |output ​ |query |Свойства возвращаемых объектов. \\ \\ Default: ''​extend''​. ​ |
 |preservekeys ​ |flag |Использование ID как ключей в результирующем массиве. ​ | |preservekeys ​ |flag |Использование ID как ключей в результирующем массиве. ​ |
Line 41: Line 40:
 |searchByAny ​ |boolean | Если задано равным ''​true'',​ возвращает результаты которые совпадают с любым из заданных критериев в ''​filter''​ или ''​search''​ параметрах вместо соответствия по всем. ​ \\ \\ По умолчанию:​ ''​false''​. ​ | |searchByAny ​ |boolean | Если задано равным ''​true'',​ возвращает результаты которые совпадают с любым из заданных критериев в ''​filter''​ или ''​search''​ параметрах вместо соответствия по всем. ​ \\ \\ По умолчанию:​ ''​false''​. ​ |
 |searchWildcardsEnabled ​ |boolean | Если задано равным ''​true'',​ включает использование "​*"​ символом шаблона в ''​search''​ параметре. ​ \\ \\ По умолчанию:​ ''​false''​. | |searchWildcardsEnabled ​ |boolean | Если задано равным ''​true'',​ включает использование "​*"​ символом шаблона в ''​search''​ параметре. ​ \\ \\ По умолчанию:​ ''​false''​. |
-|sortfield ​ |string/​array |Сортировка результата по заданным свойствам. Обратитесь к отдельным описаниям get методов API для получения списка свойств,​ которые можно использовать при сортировке. |+|sortfield ​ |string/​array |Сортировка результата по заданным свойствам. Обратитесь к отдельным описаниям get методов API для получения списка свойств,​ которые можно использовать при сортировке. Макросы не раскрываются до сортировки. |
 |sortorder ​ |string/​array |Порядок сортировки. Если передан массив,​ каждое значение будет сопоставляться соответствующему свойству из ''​sortfield''​ параметра.\\ \\ Возможные значения:​ \\ ''​ASC''​ - по возрастанию;​ \\ ''​DESC''​ - по убыванию. ​ | |sortorder ​ |string/​array |Порядок сортировки. Если передан массив,​ каждое значение будет сопоставляться соответствующему свойству из ''​sortfield''​ параметра.\\ \\ Возможные значения:​ \\ ''​ASC''​ - по возрастанию;​ \\ ''​DESC''​ - по убыванию. ​ |
 |startSearch ​ |flag |''​search''​ параметр будет сравнивать начало полей, то есть, выполнять ''​LIKE "​…%"''​ поиск. ​ | |startSearch ​ |flag |''​search''​ параметр будет сравнивать начало полей, то есть, выполнять ''​LIKE "​…%"''​ поиск. ​ |