[comment]: # ({8246351f-8246351f})
# itemprototype.get

[comment]: # ({/8246351f-8246351f})

[comment]: # ({a7f55ee1-5f97ef4a})
### Описание

`integer/array itemprototype.get(параметры объекта)`

Этот метод позволяет получать прототипы элементов данных в соответствии
с заданными параметрами.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/a7f55ee1-5f97ef4a})

[comment]: # ({3de42ad3-8d6ecc79})
### Параметры

`(object)` Параметры, определяющие желаемый результат.

Метод поддерживает следующие параметры.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|discoveryids|ID/array|Возвращать только прототипы элементов данных, которые принадлежат указанным правилам LLD.|
|graphids|ID/array|Возвращать только прототипы элементов данных, которые используются в указанных прототипах графиков.|
|hostids|ID/array|Возвращать только прототипы элементов данных, которые принадлежат указанным узлам сети.|
|inherited|boolean|Если задано `true`, возвращать только прототипы элементов данных, унаследованные от шаблона.|
|itemids|ID/array|Возвращать только прототипы элементов данных с указанными ID.|
|monitored|boolean|Если задано `true`, возвращать только включенные прототипы элементов данных, которые принадлежат контролируемым узлам сети.|
|templated|boolean|Если задано `true`, возвращать только прототипы элементов данных, которые принадлежат шаблонам.|
|templateids|ID/array|Возвращать только прототипы элементов данных, которые принадлежат указанным шаблонам.|
|triggerids|ID/array|Возвращать только прототипы элементов данных, которые используются в указанных прототипах триггеров.|
|selectDiscoveryData|query|Возвращать свойство `discoveryData` с данными объекта обнаружения прототипа элемента данных. Объект обнаружения прототипа элемента данных связывает обнаруженный прототип элемента данных с прототипом элемента данных, из которого он был обнаружен.<br><br>Он имеет следующие свойства:<br>`parent_itemid` - `(string)` ID прототипа элемента данных, из которого был создан прототип элемента данных;<br>`key_` - `(string)` ключ прототипа элемента данных;<br>`status` - `(int)` статус обнаружения прототипа элемента данных:<br>0 - *(по умолчанию)* прототип элемента данных обнаружен,<br>1 - прототип элемента данных больше не обнаружен;<br>`ts_delete` - `(timestamp)` время, когда прототип элемента данных, который больше не обнаружен, будет удален;<br>`ts_disable` - `(timestamp)` время, когда прототип элемента данных, который больше не обнаружен, будет отключен;<br>`disable_source` - `(int)` признак того, был ли прототип элемента данных отключен правилом LLD или вручную:<br>0 - *(по умолчанию)* отключен автоматически,<br>1 - отключен правилом LLD.|
|selectDiscoveryRule|query|Возвращать свойство [`discoveryRule`](/manual/api/reference/discoveryrule/object#lld-rule) с правилом низкоуровневого обнаружения, к которому принадлежит прототип элемента данных.|
|selectDiscoveryRulePrototype|query|Возвращать свойство [`discoveryRulePrototype`](/manual/api/reference/discoveryruleprototype/object) с родительским прототипом правила LLD, к которому принадлежит прототип элемента данных.|
|selectGraphs|query|Возвращать свойство [`graphs`](/manual/api/reference/graphprototype/object#graph-prototype) с прототипами графиков, в которых используется прототип элемента данных.<br><br>Поддерживает `count`.|
|selectHosts|query|Возвращать свойство [`hosts`](/manual/api/reference/host/object) с массивом узлов сети, к которым принадлежит прототип элемента данных.|
|selectInheritedTags|query|Возвращать свойство [`inheritedTags`](/manual/api/reference/itemprototype/object#item-prototype-tag) с тегами, которые находятся на шаблоне/узле сети/связанных шаблонах.|
|selectTags|query|Возвращать теги прототипа элемента данных в свойстве [`tags`](/manual/api/reference/itemprototype/object#item-prototype-tag).|
|selectTriggers|query|Возвращать свойство [`triggers`](/manual/api/reference/triggerprototype/object#trigger-prototype) с прототипами триггеров, в которых используется прототип элемента данных.<br><br>Поддерживает `count`.|
|selectPreprocessing|query|Возвращать свойство [`preprocessing`](/manual/api/reference/itemprototype/object#item-prototype-preprocessing) с параметрами предварительной обработки прототипа элемента данных.|
|selectValueMap|query|Возвращать свойство [`valuemap`](/manual/api/reference/valuemap/object) с картой значений прототипа элемента данных.|
|filter|object|Возвращать только те результаты, которые точно соответствуют заданному фильтру.<br><br>Принимает объект, где ключи — это имена свойств, а значения — либо одно значение, либо массив значений, с которыми выполняется сравнение.<br><br>Не поддерживает свойства с [типом данных](/manual/api/reference_commentary#data-types) `text`.<br><br>Поддерживает дополнительные свойства:<br>`host` - техническое имя узла сети, к которому принадлежит прототип элемента данных.|
|limitSelects|integer|Ограничивает количество записей, возвращаемых подвыборами.<br><br>Применяется к следующим подвыборам:<br>`selectGraphs` - результаты будут отсортированы по `name`;<br>`selectTriggers` - результаты будут отсортированы по `description`.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `itemid`, `name`, `key_`, `delay`, `type`, `status`, `history`, `trends`, `discovered`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/3de42ad3-8d6ecc79})

[comment]: # ({7223bab1-7223bab1})
### Возвращаемые значения

`(целое число/массив)` Возвращает либо:

- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Примеры

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({637433bd-92651f4c})
#### Получение прототипов элементов данных из правила LLD

Получить все прототипы элементов данных для указанного ID правила LLD.

[Запрос](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "output": "extend",
        "discoveryids": "27426"
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "23077",
            "type": "0",
            "snmp_oid": "",
            "hostid": "10079",
            "name": "Incoming network traffic on en0",
            "key_": "net.if.in[en0]",
            "delay": "1m",
            "history": "1w",
            "trends": "365d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "bps",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        },
        {
            "itemid": "10010",
            "type": "0",
            "snmp_oid": "",
            "hostid": "10001",
            "name": "Processor load (1 min average per core)",
            "key_": "system.cpu.load[percpu,avg1]",
            "delay": "1m",
            "history": "1w",
            "trends": "365d",
            "status": "0",
            "value_type": "0",
            "trapper_hosts": "",
            "units": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "0",
            "description": "Загрузка процессора рассчитывается как загрузка CPU системы, деленная на количество ядер CPU.",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}
```

[comment]: # ({/637433bd-92651f4c})

[comment]: # ({3c8f8511-acb23a7a})
#### Поиск зависимого элемента данных

Найдите один зависимый элемент данных для указанного ID элемента данных.

[Запрос](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "output": "extend",
        "filter": {
            "type": 18,
            "master_itemid": "25545"
        },
        "limit": "1"
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "25547",
            "type": "18",
            "snmp_oid": "",
            "hostid": "10116",
            "name": "Seconds",
            "key_": "apache.status.uptime.seconds",
            "delay": "0",
            "history": "90d",
            "trends": "365d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "0",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "0",
            "interfaceid": "0",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "25545",
            "timeout": "",
            "url": "",
            "query_fields": [],
            "posts": "",
            "status_codes": "200",
            "follow_redirects": "1",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "0",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}
```

[comment]: # ({/3c8f8511-acb23a7a})

[comment]: # ({a9e7c7e6-18563427})
#### Поиск прототипа элемента данных HTTP agent

Найдите прототип элемента данных HTTP agent с методом запроса HEAD для указанного ID узла сети.

[Запрос](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "itemprototype.get",
    "params": {
        "hostids": "10254",
        "filter": {
            "type": 19,
            "request_method": 3
        }
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "itemid": "28257",
            "type": "19",
            "snmp_oid": "",
            "hostid": "10254",
            "name": "discovered",
            "key_": "item[{#INAME}]",
            "delay": "{#IUPDATE}",
            "history": "90d",
            "trends": "30d",
            "status": "0",
            "value_type": "3",
            "trapper_hosts": "",
            "units": "",
            "formula": "",
            "logtimefmt": "",
            "templateid": "28255",
            "valuemapid": "0",
            "params": "",
            "ipmi_sensor": "",
            "authtype": "0",
            "username": "",
            "password": "",
            "publickey": "",
            "privatekey": "",
            "flags": "2",
            "interfaceid": "2",
            "description": "",
            "inventory_link": "0",
            "lifetime": "7d",
            "evaltype": "0",
            "jmx_endpoint": "",
            "master_itemid": "0",
            "timeout": "",
            "url": "{#IURL}",
            "query_fields": [],
            "posts": "",
            "status_codes": "",
            "follow_redirects": "0",
            "post_type": "0",
            "http_proxy": "",
            "headers": [],
            "retrieve_mode": "0",
            "request_method": "3",
            "output_format": "0",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "allow_traps": "0",
            "discover": "0",
            "uuid": "",
            "lifetime_type": "0",
            "enabled_lifetime_type": "2",
            "enabled_lifetime": "0",
            "parameters": []
        }
    ],
    "id": 1
}
```

[comment]: # ({/a9e7c7e6-18563427})

[comment]: # ({784c3a3e-b9b138b8})
### См. также

-   [Узел сети](/manual/api/reference/host/object#host)
-   [Прототип графика](/manual/api/reference/graphprototype/object#graph-prototype)
-   [Прототип триггера](/manual/api/reference/triggerprototype/object#trigger-prototype)

[comment]: # ({/784c3a3e-b9b138b8})

[comment]: # ({e1523143-e1523143})
### Источник

CItemPrototype::get() в
*ui/include/classes/api/services/CItemPrototype.php*.

[comment]: # ({/e1523143-e1523143})