[comment]: # ({7f8cd3a3-7f8cd3a3})
# httptest.get

[comment]: # ({/7f8cd3a3-7f8cd3a3})

[comment]: # ({70e0f3e6-96cbc36d})
### Описание

`integer/array httptest.get(object parameters)`

Метод позволяет получать веб-сценарии в соответствии с заданными параметрами.

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

[comment]: # ({/70e0f3e6-96cbc36d})

[comment]: # ({6422f5ac-7be2c19f})
### Параметры

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

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

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|groupids|ID/array|Возвращать только веб-сценарии, которые принадлежат указанным группам узлов сети.|
|hostids|ID/array|Возвращать только веб-сценарии, которые принадлежат указанным узлам сети.|
|httptestids|ID/array|Возвращать только веб-сценарии с указанными ID.|
|inherited|boolean|Если установлено значение `true`, возвращать только веб-сценарии, унаследованные от шаблона.|
|monitored|boolean|Если установлено значение `true`, возвращать только включенные веб-сценарии, которые принадлежат контролируемым узлам сети.|
|templated|boolean|Если установлено значение `true`, возвращать только веб-сценарии, которые принадлежат шаблонам.|
|templateids|ID/array|Возвращать только веб-сценарии, которые принадлежат указанным шаблонам.|
|expandName|flag|Расширять макросы в имени веб-сценария.|
|expandStepName|flag|Расширять макросы в именах шагов сценария.|
|evaltype|integer|Метод [оценки тегов](/manual/web_interface/frontend_sections/data_collection/web#using-filter).<br><br>Возможные значения:<br>0 - *(по умолчанию)* И;<br>2 - ИЛИ.|
|tags|array|Возвращать только веб-сценарии с указанными тегами.<br>Формат: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`.<br>Пустой массив возвращает все веб-сценарии.<br><br>Возможные значения [оператора](/manual/web_interface/frontend_sections/data_collection/web#using-filter):<br>0 - *(по умолчанию)* Содержит;<br>1 - Равно;<br>2 - Не содержит;<br>3 - Не равно;<br>4 - Существует;<br>5 - Не существует.|
|selectHosts|query|Возвращать узлы сети, которым принадлежит веб-сценарий, в виде массива в свойстве [`hosts`](/manual/api/reference/host/object).|
|selectSteps|query|Возвращать шаги веб-сценария в свойстве [`steps`](/manual/api/reference/httptest/object#scenario-step).<br><br>Поддерживает `count`.|
|selectTags|query|Возвращать теги веб-сценария в свойстве [`tags`](/manual/api/reference/httptest/object#web-scenario-tag).|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `httptestid`, `name`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/6422f5ac-7be2c19f})

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

`(integer/array)` Возвращает либо:

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

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

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

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

[comment]: # ({300b343b-c93618d6})
#### Получение веб-сценария

Получить все данные о веб-сценарии "9".

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

```json
{
    "jsonrpc": "2.0",
    "method": "httptest.get",
    "params": {
        "output": "extend",
        "selectSteps": "extend",
        "httptestids": "9"
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "httptestid": "9",
            "name": "Homepage check",
            "delay": "1m",
            "status": "0",
            "variables": [],
            "agent": "Zabbix",
            "authentication": "0",
            "http_user": "",
            "http_password": "",
            "hostid": "10084",
            "templateid": "0",
            "http_proxy": "",
            "retries": "1",
            "ssl_cert_file": "",
            "ssl_key_file": "",
            "ssl_key_password": "",
            "verify_peer": "0",
            "verify_host": "0",
            "headers": [],
            "steps": [
                {
                    "httpstepid": "36",
                    "httptestid": "9",
                    "name": "Homepage",
                    "no": "1",
                    "url": "http://example.com",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "variables": [
                        {
                            "name":"{var}",
                            "value":"12"
                        }
                    ],
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "headers": [],
                    "query_fields": []
                },
                {
                    "httpstepid": "37",
                    "httptestid": "9",
                    "name": "Homepage / About",
                    "no": "2",
                    "url": "http://example.com/about",
                    "timeout": "15s",
                    "posts": "",
                    "required": "",
                    "status_codes": "200",
                    "variables": [],
                    "follow_redirects": "1",
                    "retrieve_mode": "0",
                    "headers": [],
                    "query_fields": []
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/300b343b-c93618d6})

[comment]: # ({2906645b-ce685d69})
### См. также

-   [узел сети](/manual/api/reference/host/object#host)
-   [Шаг сценария](object#scenario-step)

[comment]: # ({/2906645b-ce685d69})

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

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

[comment]: # ({/8ec619ff-8ec619ff})