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
ru:manual:api:reference_commentary [2015/12/26 22:44]
dotneft created
ru:manual:api:reference_commentary [2017/11/13 19:24] (current)
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 24: Line 24:
   * //​только чтение//​ - значение этого свойства устанавливается автоматически не может быть определено или изменено клиентом;​   * //​только чтение//​ - значение этого свойства устанавливается автоматически не может быть определено или изменено клиентом;​
   * //​константа//​ - значение этого свойства можно устанавливать при создании объекта,​ но нельзя менять после.   * //​константа//​ - значение этого свойства можно устанавливать при создании объекта,​ но нельзя менять после.
 +
 +==== Удаление ссылки на объект через API ====
 +
 +Зарезервированное значение ID %%"​0"​%% можно использовать для удаления ссылок на объекты. Например,​ для удаления ссылки на прокси с узла сети, proxy_hostid необходимо задать значением 0 (%%"​proxy_hostid":​ "​0"​%%).
  
 ==== Общие параметры "​get"​ метода ==== ==== Общие параметры "​get"​ метода ====
Line 30: Line 34:
  
 ^  Параметр ​ ^  Тип ​ ^  Описание ​ ^  ^  Параметр ​ ^  Тип ​ ^  Описание ​ ^ 
-|countOutput ​ |flag |Возвращает в результате количество записей вместо актуальных данных. ​ | +|countOutput ​ |флаг ​|Возвращает в результате количество записей вместо актуальных данных. ​ | 
-|editable | boolean ​If set to ''​true'' ​return only objects that the user has write permissions to. \\ \\ Default: ''​false''​. | +|editable | логический ​Если задано равным ​''​true''​, возвращает только те объекты на которые у пользователя есть права на запись. \\ \\ По умолчанию: ''​false''​. | 
-|excludeSearch ​ |flag |Return results that do not match the criteria given in the ''​search'' ​parameter.|  +|excludeSearch ​ |флаг ​|Возвращает результаты,​ которые не совпадают с заданным критерием ​''​search'' ​параметре.|  
-|filter ​ |object ​|Return only those results that exactly match the given filter.\\ \\ Accepts an arraywhere the keys are property namesand the values are either a single value or an array of values to match against. \\ \\ Doesn'​t work for ''​text'' ​fields. | +|filter ​ |объект ​|Возвращать только те результаты,​ которые в точности совпадают с заданным фильтром.\\ \\ Принимает массивгде ключи являются именами свойств и значениялибо одно значение,​ либо массив значений соответствий. \\ \\ Не работает с ''​text'' ​полями. | 
-|limit ​ |integer ​|Limit the number of records returned.  | +|limit ​ |целое число ​|Ограничение количества возвращаемых записей.  | 
-|nodeids ​ |string/array |Returns objects that belong to the given nodes. | +|nodeids ​ |строка/массив ​|Возвращает объекты,​ которые принадлежат заданным нодам. | 
-|output ​ |query |Object properties to be returned. \\ \\ Default: ''​extend''​. ​ | +|output ​ |запрос ​|Свойства возвращаемых объектов. \\ \\ По умолчанию: ''​extend''​. ​ | 
-|preservekeys ​ |flag |Use IDs as keys in the resulting array.  | +|preservekeys ​ |флаг ​|Использование ID как ключей в результирующем массиве.  | 
-|search ​ |object ​|Return results that match the given wildcard search.\\ \\ Accepts an arraywhere the keys are property names, and the values are strings to search forIf no additional options are giventhis will perform a ''​LIKE "​%…%"'' ​search.\\ \\ Works only for ''​string'' ​and ''​text'' ​fields. | +|search ​ |объект ​|Возвращаемые результаты,​ которые соответствуют заданному шаблону поиска.\\ \\ Принимает массивгде ключами являются имена свойств и строковые значения для поискаЕсли не заданы дополнительные опцииэта опция выполнит ​''​LIKE "​%…%"'' ​поиск.\\ \\ Работает только с ''​string'' ​и ''​text'' ​полями. | 
-|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 ​ |логический ​Если задано равным ​''​true''​, возвращает результаты которые совпадают с любым из заданных критериев в ''​filter'' ​или ​''​search'' ​параметрах вместо соответствия по всем.  \\ \\ По умолчанию: ''​false''​. ​ | 
-|searchWildcardsEnabled ​ |boolean ​If set to ''​true'' ​enables the use of "​*" ​as a wildcard character in the ''​search'' ​parameter.  \\ \\ Default: ''​false''​. | +|searchWildcardsEnabled ​ |логический ​Если задано равным ​''​true''​, включает использование ​"​*" ​символом шаблона в ''​search'' ​параметре.  \\ \\ По умолчанию: ''​false''​. | 
-|sortfield ​ |string/array |Sort the result by the given propertiesRefer to a specific API get method description for a list of properties that can be used for sorting. | +|sortfield ​ |строка/массив ​|Сортировка результата по заданным свойствамОбратитесь к отдельным описаниям ​get методов API для получения списка свойств,​ которые можно использовать при сортировке. Макросы не раскрываются до сортировки. | 
-|sortorder ​ |string/array |Order of sortingIf an array is passedeach value will be matched to the corresponding property given in the ''​sortfield'' ​parameter.\\ \\ Possible values are: \\ ''​ASC''​ - ascending; \\ ''​DESC''​ - descending.  | +|sortorder ​ |строка/массив ​|Порядок сортировкиЕсли передан массивкаждое значение будет сопоставляться соответствующему свойству из ''​sortfield'' ​параметра.\\ \\ Возможные значения: \\ ''​ASC''​ - по возрастанию; \\ ''​DESC''​ - по убыванию.  | 
-|startSearch ​ |flag |The ''​search'' ​parameter will compare the beginning of fieldsthat isperform a ''​LIKE "​…%"'' ​search instead.  |+|startSearch ​ |флаг ​|''​search'' ​параметр будет сравнивать начало полейто естьвыполнять ​''​LIKE "​…%"'' ​поиск.  |