[comment]: # translation:outdated

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

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

[comment]: # ({f56680ab-96cbc36d})
### Descrição

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

O método permite recuperar cenários da web de acordo com 
os parâmetros fornecidos.

::: noteclassic
Este método está disponível para usuários de qualquer tipo. As 
permissões para chamar o método podem ser revogadas nas configurações 
de função do usuário. Consulte [Funções de usuário](/manual/web_interface/frontend_sections/administration/user_roles)
para obter mais informações.
:::

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

[comment]: # ({2ca6ed55-7be2c19f})
### Parâmetros

`(object)` Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|groupids|string/array|Retornar apenas cenários Web que pertencem aos grupos de hosts fornecidos.|
|hostids|string/array|Retornar apenas cenários Web que pertencem aos hosts fornecidos.|
|httptestids|string/array|Retornar apenas cenários web com os IDs fornecidos.|
|inherited|boolean|Se definido como `true`, retorna apenas cenários web herdados de um modelo.|
|monitored|boolean|Se definido como `true`, retorna apenas cenários Web habilitados que pertencem a hosts monitorados.|
|templated|boolean|Se definido como `true`, retornará apenas cenários da Web que pertencem a modelos.|
|templateids|string/array|Retornar apenas cenários da Web que pertencem aos modelos fornecidos.|
|expandName|flag|Expandir macros no nome do cenário web.|
|expandStepName|flag|Expandir macros nos nomes das etapas do cenário.|
|evaltype|integer|Regras para pesquisa de tags.<br><br>Valores possíveis:<br>0 - (padrão) And/Or;<br>2 - Or.|
|tags|array de objetos|Retorne apenas cenários Web com as tags fornecidas. Correspondência exata por tag e pesquisa com distinção entre maiúsculas e minúsculas por valor de tag, dependendo do valor do operador.<br>Formato: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`.<br>Uma matriz vazia retorna todos os cenários web.<br><br>Tipos de operadores possíveis:<br>0 - (padrão) Like;<br>1 - Equal;<br>2 - Not like;<br>3 - Not equal<br>4 - Exists;<br>5 - Not exists.|
|selectHosts|query|Retorne os hosts aos quais o cenário da web pertence como um array na propriedade [hosts](/manual/api/reference/host/object).|
|selectSteps|query|Retorne as etapas do cenário da Web na propriedade [steps](/manual/api/reference/httptest/object#scenario_step).<br><br>Suporta `count`.|
|selectTags|query|Retorne as tags do cenário web na propriedade [tags](/manual/api/reference/httptest/object#web_scenario_tag).|
|sortfield|string/array|Classifique o resultado pelas propriedades fornecidas.<br><br>Os valores possíveis são: `httptestid` e `name`.|
|countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes no [reference commentary](/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]: # ({/2ca6ed55-7be2c19f})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(integer/array)` Retorna ou:

-   uma série de objetos;
-   a contagem de objetos recuperados, se o parâmetro `countOutput` foi usado.

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

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

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

[comment]: # ({68bb57ce-c93618d6})
#### Recuperando um cenário web

Recupere todos os dados sobre o cenário web "4".

Request:

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

Response:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "httptestid": "9",
            "name": "Homepage check",
            "nextcheck": "0",
            "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]: # ({/68bb57ce-c93618d6})

[comment]: # ({ce685d69-ce685d69})
### Veja também

-   [Host](/manual/api/reference/host/object#host)
-   [Scenario step](object#scenario_step)

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

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

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

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