起動接続としてのRESTアダプタの追加
「RESTアダプタ」を起動接続として統合キャンバスにドラッグすると、アダプタ・エンドポイント構成ウィザードが起動されます。 ウィザードで選択した内容に基づいて、次のページを表示できます。
RESTアダプタが基本情報ページを起動
RESTアダプタのユーザー名、説明、相対リソースURIおよびエンドポイント・アクションを入力します。 問合せパラメータとテンプレート・パラメータの追加や、エンドポイントのリクエストまたはレスポンス(あるいは両方)の構成も選択できます。
| 要素 | 説明 |
|---|---|
|
エンドポイントにどのような名前を付けますか。 |
他のユーザーが接続について理解できるようにわかりやすい名前を指定します。 たとえば、ソースOracle REST接続を作成している場合は、
ExposeFlowAsRESTResourceという名前を付けることができます。 名前に使用できるのは、英字、数字、アンダースコアおよびハイフンです。 次のものは使用できません。
|
|
このエンドポイントでは何が行われますか。 |
必要に応じて、接続の処理内容の説明を入力します(たとえば、 |
|
What is the endpoint’s relative resource URI? |
リソースに関連付けられた相対パスを指定します。 このパスには、テンプレート・パラメータを中カッコで囲んで指定できます(たとえば、{order-id})。 対処できる特定の情報のソースをリソースとして指定できます。 リソース・パスの形式は、接頭辞付きURLの後に指定の相対パスを付加したものです。 デフォルトではURLの接頭辞は次のパスです。 たとえば、統合名が このURLは、次に示す先頭の固定部分を除いてオーバーライドできます。 |
|
エンドポイントでどのアクションを実行しますか。 |
エンドポイントで実行する1つのHTTPアクション(メソッド)を選択します。
|
|
構成するオプションを選択してください |
構成するオプションを選択します。
|
|
Configure Request Headers? |
構成するリクエスト・ヘッダーのタイプを選択します。
|
|
Configure Response Headers? |
構成するレスポンス・ヘッダーのタイプを選択します。
|
RESTアダプタ起動リクエスト・パラメータ・ページ
このエンドポイントについてRESTアダプタのリクエスト・パラメータを入力します。
| 要素 | 説明 |
|---|---|
|
Resource URI |
Basic Infoページに入力された、エンドポイントの相対URIが表示されます。 |
| HTTPメソッド | 「基本情報」ページで選択したエンドポイントで実行するアクションが表示されます。 |
|
Specify Query Parameters |
RESTエンドポイントの問合せパラメータを指定します。 「Add」アイコンをクリックすると、パラメータ名を入力してデータ型を選択するための行が表示されます。 たとえば、 「Delete」アイコンをクリックすると、選択した行が削除されます。 |
|
Template Parameters |
相対リソースURIのテンプレート・パラメータが表示されます。 テンプレート・パラメータは、Basic Infoページに指定した詳細情報に基づいています。編集することはできません。 テンプレート・パラメータは、パスの一部として中カッコで囲んで定義する必要があります。 たとえば、URL ノート:
|
RESTアダプタ起動リクエスト・ページ
エンドポイントについてRESTアダプタのリクエスト・ペイロードの詳細を入力します。
| 要素 | 説明 |
|---|---|
|
マルチパート添付処理オプションの選択 |
|
|
リクエスト・ペイロード書式を選択 |
ノート:
使用するリクエスト・ペイロード形式を選択します。 リクエスト・ペイロードの主要部は、表現の構造をXSD要素を使用して定義する必要があります。
|
|
Schema Location |
次のいずれかの方法でスキーマ・ファイルを指定します。
|
|
要素 |
ペイロードの構造を定義する要素を選択します。 このフィールドは、リクエスト・ペイロード・ファイルをインポートした後で表示されます。 スキーマまたはJSONサンプル・ファイルを参照して選択したら、スキーマが自動的に表示されます。 ルート要素を選択するためのコンボ・ボックスもデフォルトで表示されます。 |
|
リクエスト本文のメディア・タイプは何ですか。 (コンテンツタイプ・ヘッダー) |
エンドポイントで受け取るマルチパート添付ファイル・タイプを選択します。 このフィールドは、「リクエストはペイロードでマルチパートです」オプションを選択した場合に表示されます。
|
| 問合せパラメータをフォーム・データとしてメッセージ本文に送信 |
ペイロードでURLエンコードされたフォーム・データを渡す場合に選択します。 値は、「リクエスト・パラメータ」ページで定義した問合せパラメータから導出されます。 ただし、問合せパラメータを送信するかわりに、このオプションが選択された状態でメッセージ本文にフォーム・データとして送信されます。 このフィールドは、アダプタ・エンドポイント構成ウィザードで次の選択を行った場合にのみ表示されます:
|
RESTアダプタ起動のリクエスト・ヘッダー・ページ
このエンドポイントについてRESTアダプタのリクエスト・ヘッダー・プロパティを入力します。
ノート:
標準ヘッダー名と同じカスタム・ヘッダー名を指定すると、エラーが発生します。 カスタム・ヘッダー名には必ず一意の名前を指定してください。使用する標準HTTPリクエスト・ヘッダーを指定します。
| 要素 | 説明 |
|---|---|
|
Add Standard Request Headers |
デフォルトのドロップダウン・リストから、使用する標準HTTPリクエスト・ヘッダーを選択します。
|
|
HTTP Header Name |
次のタスクを実行します。
|
使用するカスタムHTTPリクエスト・ヘッダーを指定します。
| 要素 | 説明 |
|---|---|
|
Add Custom Request Headers |
次のカスタム・リクエスト・ヘッダー・タスクを実行します。
|
|
Custom Header Name |
カスタム・ヘッダー名を入力します。 |
|
Custom Header Description |
オプションで説明を入力します。 |
RESTアダプタ起動レスポンス・ページ
エンドポイントについてRESTアダプタのレスポンス・ペイロードの詳細を入力します。
| 要素 | 説明 |
|---|---|
|
Resource URI |
Basic Infoページに入力された、エンドポイントの相対URIが表示されます。 |
| HTTPメソッド | 「基本情報」ページで選択したエンドポイントで実行するアクションが表示されます。 |
|
マルチパート添付処理オプションの選択 |
リクエストがインバウンドとアウトバウンドのいずれであるかに基づいて、次のオプションを構成します。 インバウンド(トリガー)・レスポンスについて、含めるマルチパート添付ファイル・タイプを選択します。
|
|
レスポンス・ペイロード書式を選択 |
ノート:
使用するレスポンス・ペイロード形式を選択します。 レスポンス・ペイロードの主要部は、表現の構造をXSD要素を使用して定義する必要があります。
|
|
Schema Location |
次のいずれかの方法でスキーマ・ファイルを指定します。
|
|
要素 |
ペイロードの構造を定義する要素を選択します。 このフィールドは、レスポンス・ペイロード・ファイルをインポートした後で表示されます。 スキーマ・ファイルを参照して選択すると、ルート要素を選択するためのコンボ・ボックスがデフォルトで表示されます。 |
|
レスポンス本文のメディア・タイプは何ですか。 (受入れヘッダー) |
エンドポイントで応答するペイロードのタイプを選択します。
エンドポイントで受け取るマルチパート添付ファイル・タイプを選択します。 このフィールドは、「レスポンスはペイロードでマルチパートです」オプションを選択した場合に表示されます。
|
RESTアダプタ起動レスポンス・ヘッダー・ページ
このエンドポイントについてRESTアダプタのレスポンス・ヘッダー・プロパティを入力します。
ノート:
標準ヘッダー名と同じカスタム・ヘッダー名を指定すると、エラーが発生します。 カスタム・ヘッダー名には必ず一意の名前を指定してください。使用する標準HTTPレスポンス・ヘッダーを指定します。
| 要素 | 説明 |
|---|---|
|
Add Standard Response Headers |
デフォルトのドロップダウン・リストから、使用する標準HTTPレスポンス・ヘッダーを選択します。
|
|
HTTP Header Name |
次のタスクを実行します。
|
使用するカスタムHTTPレスポンス・ヘッダーを指定します。
| 要素 | 説明 |
|---|---|
|
Add Custom Response Headers |
次のカスタム・レスポンス・ヘッダー・タスクを実行します。
|
|
Custom Header Name |
カスタム・ヘッダー名を入力します。 |
|
Custom Header Description |
オプションで説明を入力します。 |
RESTアダプタ起動操作選択ページ
このエンドポイントについてRESTアダプタの呼出し操作選択パラメータを入力します。
| 要素 | 説明 |
|---|---|
|
Business Object |
この接続で使用するビジネス・オブジェクト(リソース)を選択します。 |
|
Operations |
この接続のビジネス・オブジェクトに対して実行する操作(メソッド)を選択します。 |
サマリー・ページ
指定したアダプタ構成値は、Summaryページで確認できます。
| 要素 | 説明 |
|---|---|
|
サマリー |
ウィザードのそれまでのページで定義した構成の値のサマリーが表示されます。 表示される情報は、アダプタによって異なる場合があります。 一部のアダプタでは、選択したビジネス・オブジェクトおよび操作名が表示されます。 生成されたXSDファイルが提供されるアダプタの場合は、XSDリンクをクリックしてそのファイルの読取り専用バージョンを表示します。 前のページに戻って値を更新するには、左パネルの適切なタブをクリックするか、「戻る」をクリックします。 構成の詳細を取り消すには、「取消」をクリックします。 「サンプルcURLの生成」をクリックして、RESTアダプタの接続構成時に選択した構成オプション(セキュリティ・ポリシー、ヘッダー、パラメータなど)のサンプル |