tRESTRequestの標準プロパティ

[API Definition / Definition] (API定義 / 定義)

[...]をクリックしてAPI定義ファイルを参照し、API定義にあるコンポーネントのエンドポイント、APIマッピング、ドキュメンテーションを初期化します。

[REST Endpoint] (RESTエンドポイント)

REST-ful WebサービスにリクエストできるようにするURIの場所をこのフィールドに入力します。"http://localhost:8088/services/customers"のように明示的なポート番号を指定するか、Talendのデフォルトポートを使い、"/services/customers"のように相対パスのみを指定します。

エンドポイントはコンテキスト変数を使って定義できます。

[REST API mapping] (REST APIマッピング)

マッピングテーブルの下にある[+]ボタンをクリックして行を追加し、HTTPリクエストを指定します。

[Output Flow] (出力フロー): [...]ボタンをクリックして、出力フローの名前を指定し、後でその出力フローのスキーマをダイアログボックスに設定します。

スキーマは必須ではないため、tRESTRequestコンポーネントに追加のパラメーターを渡す必要がない場合は、スキーマを空のままにしておくこともできます。ただし、[URI Pattern] (URIパターン)フィールドにURIパスのパラメーターを設定してある場合、または、[REST Endpoint] (RESTエンドポイント)フィールドで指定したURIに、URIクエリー、HTTPヘッダー、またはフォームパラメーターなど、オプションのリクエストパラメーターを追加する必要がある場合は、スキーマに入力する必要があります。

スキーマに名前bodyを追加し、POSTおよびPUTメソッドのリクエスト本文を取得します。[Document] (ドキュメント)、[String] (文字列)、および[Byte] (バイト)の型がサポートされています。

HTTP Verb: HTTP方式(GET/POST/PUT/PATCH/DELETE/OPTIONS/HEAD)をリストから選択します。

[URI pattern] (URIパターン): リソースを説明するREST-ful URIをこのフィールドに入力します。

[Consumes] (コンシューム): HTTP方式がPOST、PUT、PATCHの場合は、コンポーネントが使用するコンシュームコンテンツの形式タイプを、[XML or JSON] (XMLまたはJSON)、XML、JSON、Form、Multipart、およびAnyの中から選択します。

[Produces] (プロデュース): HTTP方式がGET、POST、PUT、PATCH、またはDELETEの場合は、コンポーネントが使用するプロデュースコンテンツの形式タイプを、[XML or JSON] (XMLまたはJSON)、XML、JSON、HTML、およびAnyから選択するか、または<oneway>を選択して、1方向のリクエストを受け入れます。

[Streaming] (ストリーミング): 大量のデータを効率的に処理できるように、レスポンスデータをチャンク形式でストリーミングするには、このチェックボックスをオンにします。

[Use Authentication (ESB runtime only)] (認証を使用（ESB runtimeで有効）)

現在のサービスで認証オプションを有効にするには、このチェックボックスをオンにします。このオプションはランタイムでのみ利用できます。認証タイプを以下から選択します。

• [Basic HTTP] (Basic認証): HTTPヘッダーに標準フィールドを使用してWebリソースへのアクセス制御を強制する最も単純な手法です。
• [SAML Token] (SAMLトークン): IDプロバイダーとサービスプロバイダーの間で認証データを交換するための、XMLベースでオープン標準のデータ形式。
• [Open ID Connect] (ID接続を開く): OAuth2の拡張機能で、クライアントは認証サーバーによって実行される認証に基づいてエンドユーザーのIDを確認したり、エンドユーザーに関する基本的なプロファイル情報を相互運用可能なRESTに類似した方法で入手したりできます。詳細は、Talend Identity and Access ManagementおよびESBリソースと認証の管理をご覧ください。

[Use Authorization] (認証サービスを使用)

このチェックボックスをオンにして、許可されたコールを有効にします。このオプションは、[Use Authentication] (認証を使用)リストで[SAML Token (ESB runtime only)] (SAMLトークン(ESB実行時のみ))を選択すると表示されます。

ユーザーのロールと権限の管理については、Managing ESB Resources and authorizationsとTalend Identity and Access Managementをご覧ください。

[Use Business Correlation] (ビジネスコリレーションを使用)

コリレーションオプションを有効にするには、このチェックボックスをオンにします。それにより、連鎖型のサービスコールが同じコリレーションIDの下にまとめられます。tRESTRequestは、要求ヘッダーからコリレーションIDを抽出してコンポーネント変数に保管し、フローで引き続き使えるようにします。

このオプションがクライアントサイドで有効になっていない場合は、コリレーションIDがtRESTRequest内に自動的に生成されます。

[tStatCatcher Statistics] (tStatCatcher統計)

このチェックボックスを選択すると、ジョブレベルやコンポーネントレベルでジョブ処理メタデータが収集されます。

グローバル変数

NB_LINE: 処理された行の数。これはAfter変数で、整数を返します。

URI: RESTリクエストのURI。これはFlow変数で、文字列を返します。

URI_BASE: RESTリクエストのベースURI。これはFlow変数で、文字列を返します。

URI_ABSOLUTE: RESTリクエストの絶対URI。これはFlow変数で、文字列を返します。

HTTP_METHOD: http方式。これはFlow変数で、文字列を返します。

ATTACHMENT_HEADERS: RESTリクエストからの添付ヘッダー。これはFlow変数で、添付ヘッダー値のリストを返します。

ATTACHMENT_FILENAMES: RESTリクエストからの添付ファイル名。これはFlow変数で、すべての添付ファイル名を返します。

PRINCIPAL_NAME: RESTリクエストのプリンシパル名。これはFlow変数で、文字列を返します。

CORRELATION_ID: チェーンされたサービス呼び出しがグルーピングされるコリレーションID。これはFlow変数で、文字列を返します。

ERROR_MESSAGE: エラーが発生した時にコンポーネントによって生成されるエラーメッセージ。これはAfter変数で、文字列を返します。この変数はコンポーネントにこのチェックボックスが存在し、[Die on error] (エラー発生時に強制終了)がオフになっている場合のみ機能します。

Flow変数はのコンポーネントの実行中に機能し、After変数はコンポーネントの実行後に機能します。

フィールドまたは式に変数を入力する場合は、Ctrl + スペースを押して変数リストにアクセスし、使用する変数を選択します。

変数の詳細は、コンテキストと変数を使用をご覧ください。

使用ルール

このコンポーネントは、Talendジョブがサービスとしてラップされ、サービスへのリクエストをジョブに入力し、ジョブ結果をサービス応答として返すことができる可能性を担います。

要求-応答の通信スタイルの場合、ジョブの結果を応答として返すには、tRESTRequestコンポーネントをtRESTResponseコンポーネントと一緒に使用する必要があります。

制限事項

コンテキスト変数をダイナミックエンドポイントやService Locatorのネームスペースに利用できるのは、Studio Talend内のみです。Talend Runtimeではサポートされていません。