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

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

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

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

El mètode permet recuperar escenaris web segons els paràmetres proveïts.

::: noteclassic
Aquest mètode és disponible per a usuaris de qualsevol mena.
Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari.
Per a més informació, veieu [Rols d'usuari](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

[comment]: # ({6422f5ac-7be2c19f})
### Paràmetres

`(object)` Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

|Paràmetre|[Tipus](/manual/api/reference_commentary#data-types)|Descripció|
|--|--|------|
|groupids|ID/array|Retorna només escenaris web que pertanyen als grups d'equips donats.|
|hostids|ID/array|Retorna només escenaris web que pertanyen als equips donats.|
|httptestids|ID/array|Retorna només escenaris web amb identificadors donats.|
|inherited|boolean|Si es defineix com a `true`, només retorna escenaris web heretats d'una plantilla.|
|monitored|boolean|Si s'estableix en `true`, només retorna els escenaris web activats que pertanyen als equips monitorats.|
|templated|boolean|Si s'estableix en `true`, només retorna escenaris web pertanyents a plantilles.|
|templateids|ID/array|Retorna només escenaris web que pertanyen a les plantilles donades.|
|expandName|flag|Amplia les macros al nom de l'escenari web.|
|expandStepName|flag|Amplia les macros als noms de les passes dels escenaris.|
|evaltype|integer|Etiqueta [mètode d'avaluació](/manual/web_interface/frontend_sections/data_collection/web#using-filter).<br><br>Valors possibles:<br>0 - *(per defecte)* I/O;<br>2 - O.|
|etiquetes|matriu|Retorna només escenaris web amb les etiquetes donades.<br>Format: `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`.<br>Una matriu buida retorna tots els escenaris web.<br><br>Valors possibles [operador](/manual/web_interface/frontend_sections/data_collection/web#using-filter):<br>0 - *(per defecte)* Conté;<br>1 - Igual a;<br>2 - No conté;<br>3 - No és igual a;<br>4 - Existeix;<br>5 - No existeix.|
|selectHosts|query|Retorna els equips als quals pertany l'escenari web com a matriu a la propietat [`hosts`](/manual/api/reference/host/object).|
|selectSteps|query|Retorna les passes de l'escenari web a la propietat [`steps`](/manual/api/reference/httptest/object#scenario_step).<br><br>Admet `count`.|
|selectTags|query|Retorna etiquetes d'escenari web a la propietat [`tags`](/manual/api/reference/httptest/object#web_scenario_tag).|
|sortfield|string/array|Ordena el resultat per propietats donades.<br><br>Els valors possibles són: `httptestid` i `name`.|
|countOutput|boolean|Aquests paràmetres es descriuen als [comentaris 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})
### Valors de retorn

`(integer/array)` Retorna un d'entre:

-   una taula d'objectes;
-   el recompte d'objectes recuperats, si s'empra el paràmetre `countOutput`.

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

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

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

[comment]: # ({300b343b-c93618d6})
#### Recuperar un escenari Web

Recupera tota la informació de l'escenari Web "9".

[Petició](/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",
            "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]: # ({/300b343b-c93618d6})

[comment]: # ({2906645b-ce685d69})
### Veieu també

-   [Equip](/manual/api/reference/host/object#host)
-   [Passa d'escenari](object#scenario-step)

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

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

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

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