ru: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
Next revision
Previous revision
Last revision Both sides next revision
ru:manual:api:reference_commentary [2015/12/26 23:22]
dotneft
ru:manual:api:reference_commentary [2017/01/03 13:34]
dotneft
Line 8: Line 8:
  
 ^ Тип ^ Описание ^ ^ Тип ^ Описание ^
-bool | Логическое значение,​ принимает либо ''​true'',​ либо ''​false''​. | +логический ​| Логическое значение,​ принимает либо ''​true'',​ либо ''​false''​. | 
-flag | Значение считается ''​true'',​ если оно указано и не равно ''​null''​ и ''​false'',​ в противном случае. | +флаг ​| Значение считается ''​true'',​ если оно указано и не равно ''​null''​ и ''​false'',​ в противном случае. | 
-integer ​| Целое число. | +целое число ​| Целое число. | 
-float | Число с плавающей точкой. | +дробное число ​| Число с плавающей точкой. | 
-string ​| Текстовая строка. | +строка ​| Текстовая строка. | 
-text | Более длинная строка текста. | +текст ​| Более длинная строка текста. | 
-timestamp ​| Штамп времени в формате Unix. | +штамп времени ​| Штамп времени в формате Unix. | 
-array | Упорядоченная последовательность значения,​ то есть, простой массив. | +массив ​| Упорядоченная последовательность значения,​ то есть, простой массив. | 
-object ​| Ассоциативный массив. | +объект ​| Ассоциативный массив. | 
-query | Значение,​ которое определяет какие данные необходимо вернуть. \\ \\ Может быть задано массивом имен свойств,​ чтобы возвращались только указанные свойства или, в том числе, одно из предопределенных значений:​ \\ ''​extend''​ - возвращает все свойства объекта;​ \\ ''​count''​ - возвращает количество полученных записей,​ поддерживается только некоторыми подзапросами. |+запрос ​| Значение,​ которое определяет какие данные необходимо вернуть. \\ \\ Может быть задано массивом имен свойств,​ чтобы возвращались только указанные свойства или, в том числе, одно из предопределенных значений:​ \\ ''​extend''​ - возвращает все свойства объекта;​ \\ ''​count''​ - возвращает количество полученных записей,​ поддерживается только некоторыми подзапросами. |
  
 === Подписи к свойствам === === Подписи к свойствам ===
Line 30: Line 30:
  
 ^  Параметр ​ ^  Тип ​ ^  Описание ​ ^  ^  Параметр ​ ^  Тип ​ ^  Описание ​ ^ 
-|countOutput ​ |flag |Возвращает в результате количество записей вместо актуальных данных. ​ | +|countOutput ​ |флаг ​|Возвращает в результате количество записей вместо актуальных данных. ​ | 
-|editable | boolean ​| Если задано равным ''​true'',​ возвращает только те объекты на которые у пользователя есть права на запись. \\ \\ По умолчанию:​ ''​false''​. | +|editable | логический ​| Если задано равным ''​true'',​ возвращает только те объекты на которые у пользователя есть права на запись. \\ \\ По умолчанию:​ ''​false''​. | 
-|excludeSearch ​ |flag |Возвращает результаты,​ которые не совпадают с заданным критерием ''​search''​ параметре.|  +|excludeSearch ​ |флаг ​|Возвращает результаты,​ которые не совпадают с заданным критерием ''​search''​ параметре.|  
-|filter ​ |object ​|Возвращать только те результаты,​ которые в точности совпадают с заданным фильтром.\\ \\ Принимает массив,​ где ключи являются именами свойств и значения,​ либо одно значение,​ либо массив значений соответствий. \\ \\ Не работает с ''​text''​ полями. | +|filter ​ |объект ​|Возвращать только те результаты,​ которые в точности совпадают с заданным фильтром.\\ \\ Принимает массив,​ где ключи являются именами свойств и значения,​ либо одно значение,​ либо массив значений соответствий. \\ \\ Не работает с ''​text''​ полями. | 
-|limit ​ |integer ​|Ограничение количества возвращаемых записей. ​ | +|limit ​ |целое число ​|Ограничение количества возвращаемых записей.  ​
-|output ​ |query |Свойства возвращаемых объектов. \\ \\ Default: ''​extend''​. ​ | +|nodeids ​ |строка/​массив |Возвращает объекты,​ которые принадлежат заданным нодам. ​
-|preservekeys ​ |flag |Использование ID как ключей в результирующем массиве. ​ | +|output ​ |запрос ​|Свойства возвращаемых объектов. \\ \\ По умолчанию: ''​extend''​. ​ | 
-|search ​ |object ​|Возвращаемые результаты,​ которые соответствуют заданному шаблону поиска.\\ \\ Принимает массив,​ где ключами являются имена свойств и строковые значения для поиска. Если не заданы дополнительные опции, эта опция выполнит ''​LIKE "​%…%"''​ поиск.\\ \\ Работает только с ''​string''​ и ''​text''​ полями. | +|preservekeys ​ |флаг ​|Использование ID как ключей в результирующем массиве. ​ | 
-|searchByAny ​ |boolean ​| Если задано равным ''​true'',​ возвращает результаты которые совпадают с любым из заданных критериев в ''​filter''​ или ''​search''​ параметрах вместо соответствия по всем. ​ \\ \\ По умолчанию:​ ''​false''​. ​ | +|search ​ |объект ​|Возвращаемые результаты,​ которые соответствуют заданному шаблону поиска.\\ \\ Принимает массив,​ где ключами являются имена свойств и строковые значения для поиска. Если не заданы дополнительные опции, эта опция выполнит ''​LIKE "​%…%"''​ поиск.\\ \\ Работает только с ''​string''​ и ''​text''​ полями. | 
-|searchWildcardsEnabled ​ |boolean ​| Если задано равным ''​true'',​ включает использование "​*"​ символом шаблона в ''​search''​ параметре. ​ \\ \\ По умолчанию:​ ''​false''​. | +|searchByAny ​ |логический ​| Если задано равным ''​true'',​ возвращает результаты которые совпадают с любым из заданных критериев в ''​filter''​ или ''​search''​ параметрах вместо соответствия по всем. ​ \\ \\ По умолчанию:​ ''​false''​. ​ | 
-|sortfield ​ |string/array |Сортировка результата по заданным свойствам. Обратитесь к отдельным описаниям get методов API для получения списка свойств,​ которые можно использовать при сортировке. | +|searchWildcardsEnabled ​ |логический ​| Если задано равным ''​true'',​ включает использование "​*"​ символом шаблона в ''​search''​ параметре. ​ \\ \\ По умолчанию:​ ''​false''​. | 
-|sortorder ​ |string/array |Порядок сортировки. Если передан массив,​ каждое значение будет сопоставляться соответствующему свойству из ''​sortfield''​ параметра.\\ \\ Возможные значения:​ \\ ''​ASC''​ - по возрастанию;​ \\ ''​DESC''​ - по убыванию. ​ | +|sortfield ​ |строка/массив ​|Сортировка результата по заданным свойствам. Обратитесь к отдельным описаниям get методов API для получения списка свойств,​ которые можно использовать при сортировке. Макросы не раскрываются до сортировки. | 
-|startSearch ​ |flag |''​search''​ параметр будет сравнивать начало полей, то есть, выполнять ''​LIKE "​…%"''​ поиск. ​ |+|sortorder ​ |строка/массив ​|Порядок сортировки. Если передан массив,​ каждое значение будет сопоставляться соответствующему свойству из ''​sortfield''​ параметра.\\ \\ Возможные значения:​ \\ ''​ASC''​ - по возрастанию;​ \\ ''​DESC''​ - по убыванию. ​ | 
 +|startSearch ​ |флаг ​|''​search''​ параметр будет сравнивать начало полей, то есть, выполнять ''​LIKE "​…%"''​ поиск. ​ |