REQUEST DOCUMENT

url は、ドキュメントにアクセスするための URL です。

「with-clause」を参照してください。

「return-clause」を参照してください。

http-response-code は、リクエストに対して返される HTTP レスポンスステータスコードです。例：200 （要求は完了しました）。

「HTTP レスポンス - リダイレクトと拒否」も参照してください。

利用できる HTTP ステータスコードのリストについては、World Wide Web Consortium（W3C）の覚書 RFC 2616 を参照してください。

user-id は、要求に対して使用されるユーザーの ID です。

user-password は、要求に対して使用されるユーザーのパスワードです。

header-value-out

header-name-out と header-value-out は、相互に組み合わせた場合にのみ使用できます。

• header-name-out は、この要求によって送信されるヘッダー変数の名前です。

• header-value-out は、この要求によって送信されるヘッダー変数の値です。

ヘッダー名にキャリッジリターン（CR）、ラインフィード（LF）、またはコロン（:）を含めることはできません。これは、REQUEST DOCUMENT ステートメントではチェックされません。有効なヘッダー名については、HTTP 仕様を参照してください。Web インターフェイスとの互換性のために、ヘッダー名はダッシュ（-）でなく下線（_）で記述できます。（内部的には、下線がダッシュで置換されます。）

ヘッダー値に CR/LF を含めることはできません。これは、REQUEST DOCUMENT ステートメントではチェックされません。有効なヘッダー値とフォーマットについては、HTTP 仕様を参照してください。

「自動生成ヘッダー」も参照してください。

outbound-document は、送信される完全なドキュメントです。この値は、HTTP REQUEST-METHOD PUT で必要です（「自動生成ヘッダー」を参照）。

REQUEST DOCUMENT ステートメントを使用したデータ転送では、通常、コードページ変換は呼び出されません。特定のコードページで送信データをエンコードする場合は、CODEPAGE オプションを使用します。

outbound-document は、デフォルトコードページ（システム変数 *CODEPAGE の値）から code-page-out で指定されたコードページにエンコードされます。

アウトバウンドドキュメントにエンコーディング（XML）または文字セット（HTML）属性が含まれている場合は、ENCODED オプションの値によりドキュメントの属性値をマップすることをお勧めします。

例：アウトバウンド XML ドキュメントに属性エンコーディング ="UTF-8" が含まれている場合、REQUEST DOCUMENT ステートメントをオプション DATA ALL #DOCUMENT ENCODED CODEPAGE 'UTF-8' でコード化します。

variable-value-out

variable-name-out および variable-value-out は、完全なドキュメントではなく、特定の DATA 変数情報のみを要求します。相互に組み合わせた場合にのみ使用できます。

• variable-name-out は、この要求によって送信される DATA 変数の名前です。

• variable-value-out は、この要求によって送信される DATA 変数の値です。この値は、HTTP REQUEST-METHODPOST で必要です（URL エンコード必須。特にアンパサンド（&）、等号（=）、パーセント記号（%）の文字）。

variable-name-out および variable-value-out が指定され、通信が http:// または https:// の場合、デフォルトでは、REQUEST-METHODPOST（「自動生成ヘッダー」を参照）とコンテンツタイプ application/x-www-form-urlencoded が使用されます。要求中、variable-name-out と variable-value-out は等号（=）およびアンパサンド（&）の文字で区切られます。したがって、等号（=）およびアンパサンド（&）文字をオペランドに含めることはできません。また、URL エンコードのため、パーセント記号（%）文字を含めることもできません。これらの文字は、予約済みとみなされ、「予約されている文字」に従ってエンコードする必要があります。

header-all-in には、HTTP レスポンスにより渡されるすべてのヘッダーデータが含まれます。

最初の行にはステータス情報が含まれ、すべての後続行には名前と値のペアとしてヘッダーが含まれます。名前は常にコロン（:）で終了し、値は改行（LF）で終了します。内部的には、すべてのキャリッジリターン（CR）／ラインフィード（LF）は改行（LF）に変換されます。

header-value-in

header-name-in および header-value-in は、特定のヘッダー情報のみを返します。相互に組み合わせた場合にのみ使用できます。

• header-name-in は、HTTP 要求によって返されるヘッダー情報の名前です。

  Web インターフェイスとの互換性のために、ヘッダー名は ダッシュ（-）文字の代わりに下線（_）で記述できます。

  （内部的には、下線がダッシュで置換されます。）header-name-in が空白の文字列の場合、ステータス情報が返されます。例：

  HTTP/1.0 200 OK

• header-value-in は、HTTP 要求によって返されるヘッダーデータを受信するために必要なスカラまたは配列の値です。

  複数の Set-Cookie ヘッダーなど、同じヘッダーの複数のオカレンスが想定される場合は、配列定義が必要です。

  多次元配列の 1 次元のみに添字範囲を含めることができます（例 9 を参照）。

  X-array は使用する前に実体化する必要があります。

  配列オカレンスの数がヘッダーの数を超えると、未使用のオカレンスがリセットされます。ヘッダー数が配列オカレンス数を超える場合、残りのヘッダー値は無視されます。

  配列定義の例については、「例 9 - 配列定義のある RETURN HEADER NAME VALUE」を参照してください。

inbound-document は、この要求に対して返されるドキュメントです。返されるページに対してエンコードは行われません。つまり、ページのエンコードは HTTP サーバーから配信されたときの状態のまま変わりません。

REQUEST DOCUMENT ステートメントを使用したデータ転送では、通常、コードページ変換は呼び出されません。特定のコードページで受信データをエンコードする場合は、ENCODED オプションを使用します。

必要な場合、inbound-document は、Natural セッションのデフォルトコードページ（システム変数 *CODEPAGE の値）にエンコードされます。

code-page-in の値が空白の場合、変換は行われません。inbound-document はデフォルトのコードページ（コンフィグレーションユーティリティのプロファイルパラメータ CP）でエンコードされます。

HTTP/HTTPS 要求のレスポンスとして、受信データにバイナリデータ（例えば image/gif）または文字データ（例えば text/html）が含まれることがあります。REQUEST DOCUMENT ステートメントは、レスポンスとともに、要求したドキュメントのコンテンツタイプ（MIME タイプ、インターネットメディアタイプともいいます）を指定するパラメータを受け取ります。このパラメータには、ドキュメントのエンコードに使用されるコードページに関する情報が含まれることがあります。mime-type は、inbound-document に返されるドキュメントのエンコードを実行する MIME タイプのリストです。

返される MIME タイプにエンコードが含まれる場合、inbound-document はこのコードページからデフォルトコードページ（A/B）または（U）にエンコードされます。

返される MIME タイプにエンコードが含まれない場合、inbound-document は code-page-in で定義されたコードページからデフォルトコードページ（システム変数 *CODEPAGE の値）（A/B）または（U）にエンコードされます。

返される MIME タイプにエンコードが含まれない場合、その MIME タイプが mime-type で指定されたタイプのいずれかと一致しているかどうか、追加のチェックが行われます。一致している場合、inbound-document は code-page-in で定義されたコードページからデフォルトコードページ（A/B）または（U）にエンコードされます。