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
ru:manual:api:reference_commentary [2017/01/06 09:21]
dotneft
ru:manual:api:reference_commentary [2018/06/13 11:55]
dotneft
Line 24: Line 24:
   * //​только чтение//​ - значение этого свойства устанавливается автоматически не может быть определено или изменено клиентом;​   * //​только чтение//​ - значение этого свойства устанавливается автоматически не может быть определено или изменено клиентом;​
   * //​константа//​ - значение этого свойства можно устанавливать при создании объекта,​ но нельзя менять после.   * //​константа//​ - значение этого свойства можно устанавливать при создании объекта,​ но нельзя менять после.
 +
 +==== Удаление ссылки на объект через API ====
 +
 +Зарезервированное значение ID %%"​0"​%% можно использовать для удаления ссылок на объекты. Например,​ для удаления ссылки на прокси с узла сети, proxy_hostid необходимо задать значением 0 (%%"​proxy_hostid":​ "​0"​%%).
  
 ==== Общие параметры "​get"​ метода ==== ==== Общие параметры "​get"​ метода ====
Line 37: Line 41:
 |output ​ |запрос |Свойства возвращаемых объектов. \\ \\ По умолчанию:​ ''​extend''​. ​ | |output ​ |запрос |Свойства возвращаемых объектов. \\ \\ По умолчанию:​ ''​extend''​. ​ |
 |preservekeys ​ |флаг |Использование ID как ключей в результирующем массиве. ​ | |preservekeys ​ |флаг |Использование ID как ключей в результирующем массиве. ​ |
-|search ​ |объект |Возвращаемые результаты,​ которые соответствуют заданному шаблону поиска.\\ \\ Принимает массив,​ где ключами являются имена свойств и строковые значения для поиска. Если не заданы дополнительные опции, эта опция выполнит ''​LIKE "​%…%"''​ поиск.\\ \\ Работает только с ''​string''​ и ''​text''​ полями. |+|search ​ |объект |Возвращаемые результаты,​ которые соответствуют заданному шаблону поиска ​(регистрозависимый).\\ \\ Принимает массив,​ где ключами являются имена свойств и строковые значения для поиска. Если не заданы дополнительные опции, эта опция выполнит ''​LIKE "​%…%"''​ поиск.\\ \\ Работает только с ''​string''​ и ''​text''​ полями. |
 |searchByAny ​ |логический | Если задано равным ''​true'',​ возвращает результаты которые совпадают с любым из заданных критериев в ''​filter''​ или ''​search''​ параметрах вместо соответствия по всем. ​ \\ \\ По умолчанию:​ ''​false''​. ​ | |searchByAny ​ |логический | Если задано равным ''​true'',​ возвращает результаты которые совпадают с любым из заданных критериев в ''​filter''​ или ''​search''​ параметрах вместо соответствия по всем. ​ \\ \\ По умолчанию:​ ''​false''​. ​ |
 |searchWildcardsEnabled ​ |логический | Если задано равным ''​true'',​ включает использование "​*"​ символом шаблона в ''​search''​ параметре. ​ \\ \\ По умолчанию:​ ''​false''​. | |searchWildcardsEnabled ​ |логический | Если задано равным ''​true'',​ включает использование "​*"​ символом шаблона в ''​search''​ параметре. ​ \\ \\ По умолчанию:​ ''​false''​. |