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

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

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

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

Cette méthode permet de récupérer des scénarios web selon les paramètres donnés.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type.
Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur.
Voir [User roles](/manual/web_interface/frontend_sections/users/user_roles) pour plus d’informations.
:::

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

[comment]: # ({6422f5ac-7be2c19f})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|groupids|ID/array|Ne retourner que les scénarios web appartenant aux groupes d'hôtes donnés.|
|hostids|ID/array|Ne retourner que les scénarios web appartenant aux hôtes donnés.|
|httptestids|ID/array|Ne retourner que les scénarios web avec les IDs donnés.|
|inherited|boolean|Si défini sur `true`, ne retourner que les scénarios web hérités d'un modèle.|
|monitored|boolean|Si défini sur `true`, ne retourner que les scénarios web activés appartenant à des hôtes surveillés.|
|templated|boolean|Si défini sur `true`, ne retourner que les scénarios web appartenant à des modèles.|
|templateids|ID/array|Ne retourner que les scénarios web appartenant aux modèles donnés.|
|expandName|flag|Développer les macros dans le nom du scénario web.|
|expandStepName|flag|Développer les macros dans les noms des étapes du scénario.|
|evaltype|integer|Méthode d'[évaluation des balises](/manual/web_interface/frontend_sections/data_collection/web#using-filter).<br><br>Valeurs possibles :<br>0 - *(par défaut)* Et/Ou;<br>2 - Ou.|
|tags|array|Ne retourner que les scénarios web avec les balises données.<br>Format : `[{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...]`.<br>Un tableau vide retourne tous les scénarios web.<br><br>Valeurs possibles de [operator](/manual/web_interface/frontend_sections/data_collection/web#using-filter) :<br>0 - *(par défaut)* Contient;<br>1 - Égal à;<br>2 - Ne contient pas;<br>3 - Différent de;<br>4 - Existe;<br>5 - N'existe pas.|
|selectHosts|query|Retourner les hôtes auxquels appartient le scénario web sous forme de tableau dans la propriété [`hosts`](/manual/api/reference/host/object).|
|selectSteps|query|Retourner les étapes du scénario web dans la propriété [`steps`](/manual/api/reference/httptest/object#scenario-step).<br><br>Prend en charge `count`.|
|selectTags|query|Retourner les balises du scénario web dans la propriété [`tags`](/manual/api/reference/httptest/object#web-scenario-tag).|
|sortfield|string/array|Trier le résultat selon les propriétés données.<br><br>Valeurs possibles : `httptestid`, `name`.|
|countOutput|boolean|Ces paramètres sont décrits dans le [commentaire de référence](/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})
### Valeurs de retour

`(integer/array)` Renvoie soit :

-   un tableau d’objets ;
-   le nombre d’objets récupérés, si le paramètre `countOutput` a été utilisé.

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

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

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

[comment]: # ({300b343b-c93618d6})
#### Récupération d'un scénario web

Récupérez toutes les données concernant le scénario web "9".

[Requête](/manual/api#performing-requests) :

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

Réponse :

```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})
### Voir aussi

-   [Hôte](/manual/api/reference/host/object#host)
-   [Étape de scénario](object#scenario-step)

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

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

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

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