[comment]: # aside: 1

[comment]: # ({b751c407-a17bb95b})
# Web scenarioオブジェクト

次のオブジェクトは、`webcheck`APIに直接関連しています。

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

[comment]: # ({24442f22-e60908bb})
### Webシナリオ

Webシナリオオブジェクトには、以下のプロパティがあります。

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|httptestid|ID|WebシナリオのID。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *read-only*<br>- 更新操作で *required*|
|hostid|ID|このWebシナリオが属するホストのID。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *constant*<br>- 作成操作で *required*|
|name|string|Webシナリオの名前。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- 作成操作で *required*|
|agent|string|Webシナリオで使用されるユーザーエージェント文字列。<br><br>デフォルト: Zabbix|
|authentication|integer|Webシナリオで使用される認証方式。<br><br>指定可能な値:<br>0 - *(default)* なし;<br>1 - Basic HTTP認証;<br>2 - NTLM認証;<br>3 - Kerberos認証;<br>4 - Digest認証。|
|delay|string|Webシナリオの実行間隔。<br><br>秒、または接尾辞付きの時間単位（例: 30s, 1m, 2h, 1d）、あるいはユーザーマクロを指定できます。<br><br>デフォルト: 1m。|
|headers|array|リクエスト実行時に送信される[HTTPヘッダー](/manual/api/reference/httptest/object#http-field)。|
|http\_password|string|Basic HTTP、NTLM、Kerberos、またはDigest認証で使用されるパスワード。|
|http\_proxy|string|*http://\[username\[:password\]@\]proxy.example.com\[:port\]* の形式で指定する、Webシナリオで使用されるプロキシ。|
|http\_user|string|Basic HTTP、NTLM、Kerberos、またはDigest認証で使用されるユーザー名。|
|retries|integer|失敗する前に、Webシナリオが各ステップの実行を試行する回数。<br><br>デフォルト: 1。|
|ssl\_cert\_file|string|クライアント認証に使用されるSSL証明書ファイル名（PEM形式である必要があります）。|
|ssl\_key\_file|string|クライアント認証に使用されるSSL秘密鍵ファイル名（PEM形式である必要があります）。|
|ssl\_key\_password|string|SSL秘密鍵のパスワード。|
|status|integer|Webシナリオが有効かどうか。<br><br>指定可能な値:<br>0 - *(default)* 有効;<br>1 - 無効。|
|templateid|ID|親テンプレートのWebシナリオID。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- *read-only*|
|variables|array|Webシナリオの[変数](/manual/api/reference/httptest/object#http-field)。|
|verify\_host|integer|接続先のホスト名が、そのホストの証明書内のホスト名と一致することを検証するかどうか。<br><br>指定可能な値:<br>0 - *(default)* ホスト検証をスキップ;<br>1 - ホストを検証。|
|verify\_peer|integer|ホストの証明書が正当であることを検証するかどうか。<br><br>指定可能な値:<br>0 - *(default)* ピア検証をスキップ;<br>1 - ピアを検証。|
|uuid|string|インポートしたWebシナリオを既存のものにリンクするために使用されるグローバル一意識別子。指定しない場合は自動生成されます。<br><br>[Property behavior](/manual/api/reference_commentary#property-behavior):<br>- Webシナリオがテンプレートに属している場合に *supported*|

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

[comment]: # ({06fda153-eb20f47d})
### シナリオステップ

シナリオステップオブジェクトは、特定のWebシナリオチェックを定義します。  
以下のプロパティがあります。

|プロパティ|[Type](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|name|string|シナリオステップの名前。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|no|integer|Webシナリオ内のステップの順序番号。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|url|string|チェックするURL。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|follow\_redirects|integer|HTTPリダイレクトに従うかどうか。<br><br>指定可能な値:<br>0 - リダイレクトに従わない;<br>1 - *(デフォルト)* リダイレクトに従う。|
|headers|array|リクエスト実行時に送信される[HTTPヘッダー](/manual/api/reference/httptest/object#http-field)。シナリオステップのヘッダーは、Webシナリオに指定されたヘッダーを上書きします。|
|posts|string/array|HTTP POST変数。文字列（raw post data）または [HTTP fields](/manual/api/reference/httptest/object#http-field) の配列（フォームフィールドデータ）として指定します。|
|required|string|レスポンス内に存在する必要があるテキスト。|
|retrieve\_mode|integer|シナリオステップが取得する必要があるHTTPレスポンスの部分。<br><br>指定可能な値:<br>0 - *(デフォルト)* 本文のみ;<br>1 - ヘッダーのみ;<br>2 - ヘッダーと本文。|
|status\_codes|string|必要なHTTPステータスコードの範囲。カンマ区切りで指定します。|
|timeout|string|リクエストのタイムアウト（秒）。秒数、サフィックス付きの時間単位、またはユーザーマクロを指定できます。<br><br>デフォルト: 15s。最大: 1h。最小: 1s。|
|variables|array|シナリオステップの[変数](/manual/api/reference/httptest/object#http-field)。|
|query\_fields|array|クエリフィールド - リクエスト実行時にURLに追加される [HTTP fields](/manual/api/reference/httptest/object#http-field) の配列。|

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

[comment]: # ({75483b8b-d69e8b7b})
#### HTTPフィールド

HTTPフィールドオブジェクトは、Webシナリオの変数、HTTPヘッダー、POSTフィールドまたはクエリフィールドを指定するために使用される名前と値を定義します。  
このオブジェクトには、以下のプロパティがあります。

|プロパティ|[Type](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|name|string|ヘッダー/変数/POSTまたはGETフィールドの名前。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|value|string|ヘッダー/変数/POSTまたはGETフィールドの値。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|

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

[comment]: # ({d93e46b7-c7ab7fb0})
### Webシナリオタグ

Webシナリオタグオブジェクトには、以下のプロパティがあります。

|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|tag|string|Webシナリオタグ名。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|value|string|Webシナリオタグ値。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*。|
|object|integer|タグの継承元オブジェクトのタイプ。<br><br>使用可能な値:<br>0 - テンプレート;<br>1 - ホスト.<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*。|
|objectid|ID|タグの継承元オブジェクトのID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*。|

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