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

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

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

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

O método permite recuperar cenários 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 de usuário.
Consulte [Funções de usuário](/manual/web_interface/frontend_sections/users/user_roles) para mais informações.
:::

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

[comment]: # ({6422f5ac-7be2c19f})
### Parâmetros

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

O método suporta os seguintes parâmetros.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|groupids|ID/array|Retorna apenas web scenarios que pertencem aos grupos de hosts informados.|
|hostids|ID/array|Retorna apenas web scenarios que pertencem aos hosts informados.|
|httptestids|ID/array|Retorna apenas web scenarios com os IDs informados.|
|inherited|boolean|Se definido como `true`, retorna apenas web scenarios herdados de um template.|
|monitored|boolean|Se definido como `true`, retorna apenas web scenarios habilitados que pertencem a hosts monitorados.|
|templated|boolean|Se definido como `true`, retorna apenas web scenarios que pertencem a templates.|
|templateids|ID/array|Retorna apenas web scenarios que pertencem aos templates informados.|
|expandName|flag|Expande macros no nome do web scenario.|
|expandStepName|flag|Expande macros nos nomes das etapas do scenario.|
|evaltype|integer|Método de [avaliação de tags](/manual/web_interface/frontend_sections/data_collection/web#using-filter).<br><br>Valores possíveis:<br>0 - *(padrão)* And/Or;<br>2 - Or.|
|tags|array|Retorna apenas web scenarios com as tags informadas.<br>Formato: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`.<br>Um array vazio retorna todos os web scenarios.<br><br>Valores possíveis de [operator](/manual/web_interface/frontend_sections/data_collection/web#using-filter):<br>0 - *(padrão)* Contém;<br>1 - Igual a;<br>2 - Não contém;<br>3 - Diferente de;<br>4 - Existe;<br>5 - Não existe.|
|selectHosts|query|Retorna os hosts aos quais o web scenario pertence como um array na propriedade [`hosts`](/manual/api/reference/host/object).|
|selectSteps|query|Retorna as etapas do web scenario na propriedade [`steps`](/manual/api/reference/httptest/object#scenario-step).<br><br>Suporta `count`.|
|selectTags|query|Retorna as tags do web scenario na propriedade [`tags`](/manual/api/reference/httptest/object#web-scenario-tag).|
|sortfield|string/array|Classifica o resultado pelas propriedades informadas.<br><br>Valores possíveis: `httptestid`, `name`.|
|countOutput|boolean|Esses parâmetros são descritos no [comentário de referência](/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})
### Valores de retorno

`(integer/array)` Retorna:

-   um array de objetos;
-   a contagem de objetos recuperados, se o parâmetro `countOutput` tiver sido usado.

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

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

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

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

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

[Request](/manual/api#performing-requests):

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

Resposta:

```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})
### Veja também

-   [Host](/manual/api/reference/host/object#host)
-   [Etapa do cenário](object#scenario-step)

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

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

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

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