REST - HTTPサービスの呼び出し

HTTPメソッドを指定してHTTPサーバーとの通信を行います。
SSL通信を行う場合、管理コンソールで登録された証明書を使用してPKI基盤に従って通信を行います。

■ストリーム情報

入力フォーマットすべて
接続数1
説明 送信データとなります。
HTTPメソッドがGET、DELETEの場合は、HTTPボディが「入力ストリーム」を指定した場合に使用されます。
入力ストリーム型にParameterListを使用した場合は、各パラメーターがフォームフィールドとして送られます。
Content-Typeに「multipart/form-data」を選択した場合は、ParameterList以外の入力ストリームは使用されません。
出力フォーマットXML,CSV,FixedLength,Text,HTML,Binary,MIME,JSON

出力ストリーム変数

名前データ型説明
StatusCodeintHTTPレスポンスのステータスコード

■コンポーネントプロパティ

名前プロパティ型マッピング説明
コネクションを使用boolean- 接続先に以下のコネクション名 を使用するかどうか選択します。
はい [true] - 以下のコネクション名 で指定されたHTTP接続名をHTTPの接続先サーバーとして使用します。
いいえ [false] - コネクション情報 以下のプロパティを使ってHTTPによる接続を行います。
コネクション名connection-コネクションを使用 が「はい」の場合に接続先のHTTPサーバーを指定します。 コネクションペインまたは管理コンソールにて作成したHTTP接続名を選択します。
コネクション情報group-コネクションを使用 プロパティが「いいえ」の場合に使用されるプロパティ群です。
URLstring入力＆出力 取得するロケーションとしてのURLを設定します。
指定するURLは「 http(s)://～ 」の形式でフルパス指定します。 コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
URLエンコーディングchoice入力＆出力 URLやボディにパラメーターを設定する際のエンコーディングを指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。URLのエンコーディングについては、下記トピック「URLのエンコーディングについて」を参照してください。
タイムアウト（秒）int入力＆出力 リクエスト時およびコネクション接続時のタイムアウトまでの時間を秒単位で指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
認証group-コネクションを使用 が「いいえ」の場合に使用される認証プロパティ群です。 サポートしている認証方式は以下の3つです。
  • Basic認証
  • Digest認証
  • WSSE認証
ユーザー名string入力＆出力 接続先のサーバーで認証を行う場合のユーザー名を設定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
パスワードpassword入力＆出力 接続先のサーバーで認証を行う場合のパスワードを設定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
ユーザーのクライアント証明書を使用boolean- クライアント認証でユーザーの証明書を使用するかどうかを指定します。
ユーザーの証明書は管理コンソールのアカウント設定で登録します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
はい [true] - ユーザーの証明書を使用します。
いいえ [false] - ユーザーの証明書を使用しません。
クライアント証明書のエイリアスstring入力＆出力ユーザーのクライアント証明書を使用 が「はい」の場合に、ユーザーの証明書として使用するエイリアス名を指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
プロキシ設定を使用boolean- 管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。
コネクションを使用 が「いいえ」の場合にこの設定が参照されます。
はい [true] - プロキシ設定を使用します。
いいえ [false] - プロキシ設定を使用しません。
パスstring入力＆出力 取得するロケーションとしてのURLを設定します。
ここで指定したURL文字列は上記のコネクション名 またはURL で指定されているURLに付加されます。
※URLのパス名に付加するパス文字列であり、スキームやホスト名を含むことはできません。
Content-Typechoice- 送信ヘッダーのContent-Typeを指定します。「multipart/form-data」を選択した場合にアップロードファイルプロパティでファイルを指定することができるようになり、送信ヘッダープロパティでのContent-Type指定より優先されます。
自動判定 [auto]
自動で判別して設定します。
multipart/form-data [multipart]
multipart/form-dataを設定します。
ファイルパスの詳細設定group-アップロードファイルプロパティでファイルを指定するときのファイルパスの詳細設定を行うプロパティ群です。
相対パスの起点pathResolver- 相対パス指定の場合にベースフォルダーを指定します。
プロジェクトフォルダー [Relative]
プロジェクトファイルと同じフォルダーを起点にします。
ホームフォルダー [ProjectOwner]
ユーザーのホームフォルダーを起点にします。
実行ユーザーのホームフォルダー [ExecuteUser]
実行ユーザーのホームフォルダーを起点にします。
絶対パスを許可boolean- 絶対パスを許可するかどうか選択します。
「..」を許可boolean- 上のフォルダへ移動する記述に「..」を許可するかどうか選択します。
HTTPメソッドchoice- リクエストに使用するHTTPのメソッドを指定します。GET、POST、PUT、DELETE以外のメソッドは直接入力して指定します。
GET - GETメソッドを使用します。
POST - POSTメソッドを使用します。
PUT - PUTメソッドを使用します。
DELETE - DELETEメソッドを使用します。
HTTPボディchoice-HTTPメソッドプロパティで「PUT」か「POST」以外を指定した場合に、HTTPボディを指定します。
入力ストリーム [Stream] - 入力ストリームを使用します。
なし [None] - ボディなし。
HTTPのバージョンchoice- リクエストに使用するHTTPのバージョンを指定します。
HTTP/1.1 の場合 ヘッダーに Connection:close がヘッダーに強制的に設定されます。
HTTP/1.0 - HTTP/1.0を使用します。
HTTP/1.1 - HTTP/1.1を使用します。
リトライ回数int入力＆出力 リクエスト時にHTTPサーバーに接続できなかったときに自動的にリトライするカウントを指定します。リトライしない場合は0を指定します。
リトライ間隔（秒）int入力＆出力 上記リトライ時に再度接続リクエストを送るまでの間隔を秒単位で指定します。
リダイレクトを処理boolean-HTTPメソッドプロパティで「GET」を指定した場合に、サーバーからリダイレクト先が返されたときの処理の方法を設定できます。
はい [true] - サーバーから返されたリダイレクトに自動的にリダイレクトします。
いいえ [false] - リダイレクトされません。
URLパラメーターcategory入力　　　URLパラメーター タブで指定したパラメーターをURLのクエリーパラメーターとして追加します。
送信ヘッダーcategory入力　　　送信ヘッダー タブで指定したパラメーターをHTTPヘッダーに載せて、HTTPリクエストを発行します。
受信ヘッダーcategory　　　出力 HTTPサーバーからのレスポンスを受信した際に、受信ヘッダー タブに指定したパラメーターに一致するヘッダー属性がある場合、そのヘッダー属性の値を受信ヘッダー タブの指定したパラメーターに設定して返します。ただし、レスポンスに同じ名前のヘッダー属性が複数存在した場合は最後の値のみ取得することができます。また、このプロパティは自動的にストリーム変数になります。本コンポーネントの後に連結したマッパーで、ストリーム変数として見えるようになっています。ストリーム変数については、「はじめに」-「詳細なトピック」-「フローの構成要素」-「変数」-「ストリーム変数」を参照してください。
アップロードファイルcategory入力　　　 指定したファイル情報から、multipart/form-dataのパートを作成します。Content-Typeに「multipart/form-data」を指定した場合のみ表示されます
パラメーター名 - パラメーター名を指定します。Content-Dispositionのname値に使用します。
ファイルパス - 送信したいサーバー上のファイルのファイルパスを指定します。
ファイル名 - ファイルパスで指定したファイル名とは別名を指定したい場合に、ファイル名を指定します。Content-Dispositionのfilename値に使用します。

■トランザクション処理

コミット何もしません。
ロールバック何もしません。

■エラー処理

タイプパラメーターエラー処理フロー
へのストリーム		エラー
コード		説明
汎用 なし コンポーネントの入力ストリーム なし コネクション名 に指定したコネクションが見つからない場合
なし HTTPサーバーに接続できない場合
HTTPException「HTTPExceptionのパラメーター 」
を参照してください。 		サーバーから返されたHTTPレスポンスのMIMEHTTPレスポンスのステータスコードHTTPサーバーがエラーを返した場合

■「HTTPException」のパラメーター

No.名前説明
1HTTPStatusLineサーバーから返されたHTTPステータスラインが返されます。
2HTTPBodyサーバーから返されたHTTPレスポンスのボティが返されます。

■HTTPGet, HTTPPostコンポーネントとの違い

本コンポーネントはHTTPGet, HTTPPostコンポーネントの機能をすべて含んでおり、代替させることができます。それらのコンポーネントとの相違点は以下の通りです。

HTTPPostコンポーネントは右クリックメニューのコンポーネントの置き換えで完全に元の動作を引き継ぐことができますが、入力ストリームとしてParameterListを受けているHTTPGetコンポーネントの場合はパラメーターの設定を「URLパラメーター」プロパティに設定し直す必要があります。

■フローの強制終了

フローを強制終了すると、通常は実行中のコンポーネントの処理が終了してから次のコンポーネントに制御が遷移する時点でフローがアボートしますが、本コンポーネントでは実行中の処理を強制的に終了してフローがアボートします。

■URLのエンコーディングについて

例えば、入力ストリームのParameterListの「param」というフィールドに「あいう」という値が設定されている場合、URLエンコーディング にShift_JISを指定するとPOSTするデータは以下のようになります。 
	param=%82%A0%82%A2%82%A4
URLエンコーディング に指定するエンコーディングの詳細についてはRFC1738をご参照ください。

■コネクションを使用するケース

コネクションを使用しない場合は接続先のURLに関する情報をすべてコンポーネントで設定しなければなりませんが、 コネクションを使用する場合は接続先ホストの基本情報をコネクションとして定義しておき「パス」プロパティとの組み合わせでURLを組み立てることができます。
例えば、コネクション定義でURLとして 

	http://SERVERNAME

のようにホスト名だけを指定しておき「パス」プロパティに「/page1.html」を指定することで 

	http://SERVERNAME/page1.html

に対してリクエストを実行することができます。
同一Webサーバーに対して複数のHTTPコンポーネントからアクセスする必要がある場合に

ようなケースではコネクションを使用する方が便利です。

■備考

■HTTPリクエストのテスト

本コンポーネントでは右クリックメニューの「テストの実行」またはコンポーネントのダブルクリックからHTTPリクエストのテストを実行することができます。

テストの実行ダイアログは以下の構成要素からなります。

テストの注意事項