Documentation
Table of Contents
> Objecte d'escenari web
Els seg¨¹ents objectes s¨®n vinculats a l'API webcheck.
Escenari web
L'objecte t¨¦ les propietats seg¨¹ents.
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| httptestid | string | (nom¨¦s lectura) ID de l'escenari web. |
| hostid (obligatori) |
string | ID de l'equip al qual pertany l'escenari web. |
| name (obligatori) |
string | Nom de l'escenari web. |
| agent | string | Cadena d'agent d'usuari que emprar¨¤ l'escenari web. Per defecte: Áú»¢¶Ä²© |
| authentication | integer | M¨¨tode d'autenticaci¨® que emprar¨¤ l'escenari web. Valors possibles: 0 - (per defecte) cap; 1 - autenticaci¨® HTTP b¨¤sica;< br>2 - ´¡³Ü³Ù±ð²Ô³Ù¾±³¦²¹³¦¾±¨® NTLM. |
| delay | string | Interval d'execuci¨® de l'escenari web. Accepta segons, unitat de temps amb sufix i macro d'usuari. Per defecte: 1m. |
| headers | array of camps 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. 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. Els valors possibles s¨®n: 0 - (per defecte) activat; 1 - desactivat. |
| templateid | string | (nom¨¦s lectura) ID de l'escenari web de la plantilla principal. |
| variables | array of camps 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. Els valors possibles s¨®n: 0 - (per defecte) no comprova l'equip; 1 - comprova l'equip. |
| verify_peer | integer | Valida Si el certificat de l'equip ¨¦s aut¨¨ntic. Els valors possibles s¨®n: 0 - (per defecte) omet la verificaci¨® d'iguals; 1 - comprova. |
| uuid | string | (nom¨¦s lectura en escenaris web ja existents) 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.
Etiqueta d'escenari web
L'objecte d'etiqueta d'escenari web t¨¦ les propietats seg¨¹ents:
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| tag (obligatori) |
string | Nom de l'etiqueta de l'escenari web. |
| value | string | Valor de l'escenari web. |
Passes de l'escenari
L'objecte defineix una comprovaci¨® d'escenari web espec¨ªfica. T¨¦ les seg¨¹ents propietats.
| Propietat | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| httpstepid | string | (nom¨¦s lectura) ID de la passa de l'escenari. |
| name (obligatori) |
string | Nom de la passa de l'escenari. |
| no (obligatori) |
integer | Nombre de seq¨¹¨¨ncia de la passa en un escenari web. |
| url (obligatori) |
string | URL per comprovar. |
| follow_redirects | integer | Si s'han de seguir o no les redireccions HTTP. Els valors possibles s¨®n: 0 - no segueix les redireccions; 1 - (per defecte) segueix les redireccions. |
| headers | array of camps HTTP | 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 array of camps HTTP |
variables HTTP POST com a cadena (dades de publicaci¨® en brut) o com a matriu de camps HTTP (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. Els valors possibles s¨®n: 0 - (per defecte) nom¨¦s cos; 1 - cap?aleres nom¨¦s; 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. Per defecte: 15 s. M¨¤xim: 1 hora. M¨ªnim: 1s. |
| variables | array of camps HTTP | Variables de passa d'escenari. |
| query | array of camps HTTP | Camps de consulta - matriu de camps HTTP que s'afegir¨¤ a l'URL quan s'executi una consulta. |
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 | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| nom (obligatori) |
string | Nom de la cap?alera / variable / camp POST o GET. |
| nom (obligatori) |
string | Valor de la cap?alera / variable / camp POST o GET. |