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

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

[comment]: # ({14fe6d53-96cbc36d})
### Descripción

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

El método permite recuperar escenarios web de acuerdo con los 
parámetros dados.

::: noteclassic
Este método está disponible para usuarios de cualquier tipo. Los permisos
para llamar al método se pueden revocar en la configuración de roles de usuario. Ver [Roles de
usuario](/manual/web_interface/frontend_sections/users/user_roles)
para más información.
:::

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

[comment]: # ({db776fad-7be2c19f})
### Parámetros

`(objeto)` Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

|Parámetro|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|groupids|cadena/matriz|Devuelve solo escenarios web que pertenecen a los grupos de equipos dados.|
|hostids|string/array|Devuelve sólo escenarios web que pertenecen a los equipos dados.|
|httptestids|string/array|Devuelve solo escenarios web con los ID proporcionados.|
|inherited|booleano|Si se establece en "verdadero", devuelve solo escenarios web heredados de una plantilla.|
|monitored|booleano|Si se establece en "verdadero", solo se devuelven escenarios web habilitados que pertenecen a equipos monitoreados.|
|templated|booleano|Si se establece en "verdadero", devuelve solo escenarios web que pertenecen a plantillas.|
|templateids|cadena/matriz|Devuelve solo escenarios web que pertenecen a las plantillas dadas.|
|expandName|flag|Expandir macros en el nombre del escenario web.|
|expandStepName|flag|Ampliar macros en los nombres de los pasos del escenario.|
|evaltype|integer|Reglas para la búsqueda de etiquetas.<br><br>Valores posibles:<br>0 - (predeterminado) Y/O;<br>2 - O.|
|tags|matriz de objetos|Devuelve solo escenarios web con etiquetas dadas. Coincidencia exacta por etiqueta y búsqueda que distinga entre mayúsculas y minúsculas por valor de etiqueta según el valor del operador.<br>Formato: `[{"tag": "<tag>", "value": "<value>", " operador": "<operador>"}, ...]`.<br>Una matriz vacía devuelve todos los escenarios web.<br><br>Tipos de operadores posibles:<br>0 - (predeterminado) Me gusta;<br> 1 - Igual;<br>2 - No me gusta;<br>3 - No igual<br>4 - Existe;<br>5 - No existe.|
|selectHosts|query|Devuelve los hosts a los que pertenece el escenario web como una matriz en la propiedad [`hosts`](/manual/api/reference/host/object).|
|selectSteps|query|Devuelve los pasos del escenario web en la propiedad [`steps`](/manual/api/reference/httptest/object#scenario_step).<br><br>Admite `count`.|
|selectTags|query|Devuelve etiquetas de escenario web en la propiedad [`tags`](/manual/api/reference/httptest/object#web_scenario_tag).|
|sortfield|string/array|Ordena el resultado según las propiedades dadas.<br><br>Valores posibles: `httptestid`, `name`.|
|countOutput|boolean|Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en el [comentario de referencia](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleano|^|
|excludeSearch|booleano|^|
|filter|objeto|^|
|limit|entero|^|
|output|consulta|^|
|preservekeys|booleano|^|
|search|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|sortorder|cadena/matriz|^|
|startSearch|booleano|^|

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

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

`(entero/matriz)` Devuelve:

- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro `countOutput` 
    ha sido usado.

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

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

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

[comment]: # ({4934c1a5-c93618d6})
#### Recuperando un escenario web

Recupere todos los datos sobre el escenario web "4".

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

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

Respuesta:

```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]: # ({/4934c1a5-c93618d6})

[comment]: # ({ce685d69-ce685d69})
### Ver también

- [Equipo](/manual/api/reference/host/object#host)
- [Paso del escenario](object#scenario_step)

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

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

CHttpsTest::get() en *ui/include/classes/api/services/CHttpsTestt.php*.

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