[comment]: # ({b751c407-a17bb95b})
# Objecte d'escenari web

Els següents objectes són vinculats a l'API `webcheck`.

[comment]: # ({/b751c407-a17bb95b})

[comment]: # ({e95765dd-e60908bb})
### Escenari web

L'objecte té les propietats següents.

|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|httptestid|string|*(només lectura)* ID de l'escenari web.|
|**hostid**<br>(obligatori)|string|ID de l'equip al qual pertany l'escenari web.|
|**name**<br>(obligatori)|string|Nom de l'escenari web.|
|agent|string|Cadena d'agent d'usuari que emprarà l'escenari web.<br><br>Per defecte: Zabbix|
|authentication|integer|Mètode d'autenticació que emprarà l'escenari web.<br><br>Valors possibles:<br>0 - *(per defecte)* cap;<br>1 - autenticació HTTP bàsica;< br>2 - Autenticació NTLM.|
|delay|string|Interval d'execució de l'escenari web. Accepta segons, unitat de temps amb sufix i macro d'usuari.<br><br>Per defecte: 1m.|
|headers|array of [camps HTTP](/manual/api/reference/httptest/object#camp HTTP)|Capçaleres HTTP que s'enviaran en executar una petició.|
|http\_password|string|el mot de pas emprat per a l'autenticació bàsica HTTP o NTLM.|
|http\_proxy|string|Proxy que emprarà l'escenari web donat com a *http://\[nom d'usuari\[:mot de pas\]@\]proxy.example.com\[:port\]*.|
|http\_user|string|Nom d'usuari emprat per a l'autenticació bàsica HTTP o NTLM.|
|nextcheck|timestamp|*(només lectura)* Hora de l'execució de l'escenari web següent.|
|retries|integer|Nombre de vegades que un escenari web intentarà executar cada passa abans de fallar.<br><br>Per defecte: 1.|
|ssl\_cert\_file|string|Nom del fitxer de certificat SSL emprat per a l'autenticació del client (ha d'ésser en format PEM).|
|ssl\_key\_file|string|Nom del fitxer de clau privada SSL emprat per a l'autenticació del client (ha d'ésser en format PEM).|
|ssl\_key\_password|string|mot de pas de clau privada SSL.|
|status|integer|Indica si l'escenari web és habilitat.<br><br>Els valors possibles són:<br>0 - *(per defecte)* activat;<br>1 - desactivat.|
|templateid|string|*(només lectura)* ID de l'escenari web de la plantilla principal.|
|variables|array of [camps HTTP](/manual/api/reference/httptest/object#camp HTTP)|variables d'escenari web.|
|verify\_host|integer|Valida si el nom de l'equip de la connexió coincideix amb el certificat de l'equip.<br><br>Els valors possibles són:<br>0 - *(per defecte)* no comprova l'equip;<br>1 - comprova l'equip.|
|verify\_peer|integer|Valida Si el certificat de l'equip és autèntic.<br><br>Els valors possibles són:<br>0 - *(per defecte)* omet la verificació d'iguals; <br>1 - comprova. |
|uuid|string|*(només lectura en escenaris web ja existents)*<br>Identificador únic global, emprat per enllaçar escenaris web importats amb els ja existents. S'empra només per a escenaris web en models.|

Tingueu en compte que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris/opcionals és diferent.

[comment]: # ({/e95765dd-e60908bb})

[comment]: # ({77f50b6b-c7ab7fb0})
### Etiqueta d'escenari web

L'objecte d'etiqueta d'escenari web té les propietats següents:

|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|**tag**<br>(obligatori)|string|Nom de l'etiqueta de l'escenari web.|
|value|string|Valor de l'escenari web.|

[comment]: # ({/77f50b6b-c7ab7fb0})

[comment]: # ({bec454ad-eb20f47d})
### Passes de l'escenari

L'objecte defineix una comprovació d'escenari web específica. Té les següents propietats.

|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|httpstepid|string|*(només lectura)* ID de la passa de l'escenari.|
|**name**<br>(obligatori)|string|Nom de la passa de l'escenari.|
|**no**<br>(obligatori)|integer|Nombre de seqüència de la passa en un escenari web.|
|**url**<br>(obligatori)|string|URL per comprovar.|
|follow\_redirects|integer|Si s'han de seguir o no les redireccions HTTP.<br><br>Els valors possibles són:<br>0 - no segueix les redireccions;<br>1 - *(per defecte)* segueix les redireccions.|
|headers|array of [camps HTTP](/manual/api/reference/httptest/object#HTTP field)|capçaleres HTTP que s'enviaran en executar una petició. Les capçaleres de passa d'escenari substituiran les capçaleres especificades per a l'escenari web.|
|httptestid|string|*(només lectura)* ID de l'escenari web al qual pertany la passa.|
|posts|string<br>array of [camps HTTP](/manual/api/reference/httptest/object#camp HTTP)|variables HTTP POST com a cadena (dades de publicació en brut) o com a matriu de [camps HTTP]( /manual /api/reference/httptest/object#HTTP field) (dades del camp del formulari).|
|required|string|Text que ha d'ésser present a la resposta.|
|retrieve\_mode|integer|Part de la resposta HTTP que hauria de retornar la passa de l'escenari.<br><br>Els valors possibles són:<br>0 - *(per defecte)* només cos;<br> 1 - capçaleres només; <br>2 - capçaleres i cos.|
|status\_codes|string|Intervals de codis d'estat HTTP obligatoris, separats per comes.|
|timeout|string|Temps d'espera de la petició, en segons. Accepta segons, unitat de temps amb sufix i macro d'usuari.<br><br>Per defecte: 15 s. Màxim: 1 hora. Mínim: 1s.|
|variables|array of [camps HTTP](/manual/api/reference/httptest/object#camp HTTP)|Variables de passa d'escenari.|
|query\fields|array of [camps HTTP](/manual/api/reference/httptest/object#camp HTTP)|Camps de consulta - matriu de [camps HTTP](/manual/api/reference/httptest/object#camp HTTP ) que s'afegirà a l'URL quan s'executi una consulta.|

[comment]: # ({/bec454ad-eb20f47d})

[comment]: # ({05773163-d69e8b7b})
### Camp HTTP

L'objecte de camp HTTP defineix un nom i un valor emprats per especificar una variable, una capçalera HTTP, les dades del camp de formulari POST o les dades de camp de petició. Té les propietats següents.

|Propietat|[Tipus](/manual/api/reference_commentary#data_types)|Descripció|
|--|--|------|
|**nom**<br>(obligatori)|string|Nom de la capçalera / variable / camp POST o GET.|
|**nom**<br>(obligatori)|string|Valor de la capçalera / variable / camp POST o GET.|

[comment]: # ({/05773163-d69e8b7b})
