機械翻訳について

起動接続としてのRESTアダプタの追加

「RESTアダプタ」を起動接続として統合キャンバスにドラッグすると、アダプタ・エンドポイント構成ウィザードが起動されます。 ウィザードで選択した内容に基づいて、次のページを表示できます。

RESTアダプタが基本情報ページを起動

RESTアダプタのユーザー名、説明、相対リソースURIおよびエンドポイント・アクションを入力します。 問合せパラメータとテンプレート・パラメータの追加や、エンドポイントのリクエストまたはレスポンス(あるいは両方)の構成も選択できます。

要素 説明

エンドポイントにどのような名前を付けますか。

他のユーザーが接続について理解できるようにわかりやすい名前を指定します。 たとえば、ソースOracle REST接続を作成している場合は、ExposeFlowAsRESTResourceという名前を付けることができます。 名前に使用できるのは、英字、数字、アンダースコアおよびハイフンです。 次のものは使用できません。
  • スペース(たとえば、My REST Connection)

  • 特殊文字(たとえば、#;83&またはres(t)4)

  • マルチバイト文字

このエンドポイントでは何が行われますか。

必要に応じて、接続の処理内容の説明を入力します(たとえば、This inbound REST connection exposes this integration flow as a REST resource)。

What is the endpoint’s relative resource URI?

リソースに関連付けられた相対パスを指定します。 このパスには、テンプレート・パラメータを中カッコで囲んで指定できます(たとえば、{order-id})。 対処できる特定の情報のソースをリソースとして指定できます。 リソース・パスの形式は、接頭辞付きURLの後に指定の相対パスを付加したものです。 デフォルトではURLの接頭辞は次のパスです。
http://host:port/integration/flowapi/rest/INTEGRATION_NAME

たとえば、統合名がExposeFlowAsRESTResourceの場合、URLは次のようになります。

http://host:port/integration/flowapi/rest/EXPOSEFLOWASRESTRESOURCE

このURLは、次に示す先頭の固定部分を除いてオーバーライドできます。

host:port/integrations

エンドポイントでどのアクションを実行しますか。

エンドポイントで実行する1つのHTTPアクション(メソッド)を選択します。
  • GET: 情報を取得(読取り)します(たとえば、問合せの実行)。 このオプションを選択した場合、このエンドポイントのリクエスト・ペイロードを構成できません。

  • PUT: 情報を更新します。

  • POST: 情報を作成します。

  • DELETE: 情報を削除します。 このオプションを選択した場合、このエンドポイントのリクエスト・ペイロードを構成できません。

    PATCH: 既存のリソースを部分的に更新します(リソースのいずれかの属性のみを更新する必要がある場合など)。

    ノート: 「PATCH」動詞は、非SSL RESTサービスでは機能しません。

構成するオプションを選択してください

構成するオプションを選択します。
  • Add and review parameters for this endpoint: クリックして、問合せパラメータを指定し、このエンドポイントのリソースURIに含めて作成したテンプレート・リクエスト・パラメータを確認します。 このオプションを選択して「Next」をクリックすると、Request Parametersページが表示されます。

  • このエンドポイントのリクエスト・ペイロードの構成: クリックして、このエンドポイントのリクエスト・ペイロードを構成します。エンドポイントがレスポンスのために使用するスキーマの場所やペイロード・タイプも指定します。 インバウンド・リクエストに添付ファイルを含める場合にこのオプションを選択することもできます。 このオプションを選択して「Next」をクリックすると、Requestページが表示されます。

  • このエンドポイントを構成してレスポンスを受信: クリックして、このエンドポイントのレスポンス・ペイロードを構成します。エンドポイントが受信するスキーマの場所やペイロード・タイプも指定します。 このオプションを選択して「Next」をクリックすると、Responseページが表示されます。

Configure Request Headers?

構成するリクエスト・ヘッダーのタイプを選択します。

  • Standard: リクエスト・メッセージに標準HTTPヘッダーを構成する場合に選択します。

  • Custom: リクエスト・メッセージにカスタムHTTPヘッダーを構成する場合に選択します。

Configure Response Headers?

構成するレスポンス・ヘッダーのタイプを選択します。

  • Standard: レスポンス・メッセージに標準HTTPヘッダーを構成する場合に選択します。

  • Custom: レスポンス・メッセージにカスタムHTTPヘッダーを構成する場合に選択します。

RESTアダプタ起動リクエスト・パラメータ・ページ

このエンドポイントについてRESTアダプタのリクエスト・パラメータを入力します。

要素 説明

Resource URI

Basic Infoページに入力された、エンドポイントの相対URIが表示されます。

HTTPメソッド 「基本情報」ページで選択したエンドポイントで実行するアクションが表示されます。

Specify Query Parameters

RESTエンドポイントの問合せパラメータを指定します。

「Add」アイコンをクリックすると、パラメータ名を入力してデータ型を選択するための行が表示されます。 たとえば、stateを指定し、データ型stringを選択します。

「Delete」アイコンをクリックすると、選択した行が削除されます。

Template Parameters

相対リソースURIのテンプレート・パラメータが表示されます。 テンプレート・パラメータは、Basic Infoページに指定した詳細情報に基づいています。編集することはできません。

テンプレート・パラメータは、パスの一部として中カッコで囲んで定義する必要があります。 たとえば、URL default/customers/{cust-id}/{ship-idには、テンプレート・パラメータのcust-idおよびship-idが含まれます。 パラメータのデータ型は変更できます。

ノート:
  • 追加または構成された問合せおよびテンプレート・パラメータは、マッパーおよび統合のアクションでマッピングできます。

  • 接続ページで指定されたURLに追加された問合せとテンプレート・パラメータの値は、マッパーに表示されません。 代わりに、これらのパラメータがマッパーに表示されるように、アダプタ・エンドポイント構成ウィザードでテンプレート・パラメータと問合せパラメータを構成する必要があります。

RESTアダプタ起動リクエスト・ページ

エンドポイントについてRESTアダプタのリクエスト・ペイロードの詳細を入力します。

要素 説明

マルチパート添付処理オプションの選択

  • リクエストはペイロードでマルチパートです: ペイロード・リクエストとしてJSONまたはXMLコンテンツとともにリクエストの一部としてマルチパート添付を送信する場合に選択します。

  • マルチパート・リクエストのタイプはmultipart/form-dataで、HTMLフォーム・ペイロードがあります: マルチパート添付をペイロード・リクエストとしてHTMLフォームとともにリクエストの一部として送信する場合に選択します。 このオプションを選択する前に、まず「レスポンスはペイロードでマルチパートです」オプションを選択する必要があります。 この選択はメディア・タイプがmultipart/form-dataであることを前提とします。

リクエスト・ペイロード書式を選択

ノート:
  • サンプルJSONまたはアップロードされたXMLスキーマが、エンドポイントと交換された実際のランタイム・メッセージを表すことを確認してください。 ランタイム・メッセージの構造またはタイプが一致しないと、エラーが発生する可能性があります。

  • ターゲット名前空間なしでスキーマ・ファイルをアップロードすると、すべてのメッセージが使用するスキーマ・ファイルにサロゲート名前空間が追加されます:
    http://xmlns.oracle.com/cloud/adapter/nxsd/surrogate

使用するリクエスト・ペイロード形式を選択します。 リクエスト・ペイロードの主要部は、表現の構造をXSD要素を使用して定義する必要があります。

  • XMLスキーマ

  • JSONサンプル: SwaggerファイルとRAMLファイルを使用するには、このオプションを選択します。 最大100KBのサイズのJSONサンプル・ファイルがサポートされています。

    JSONサンプル・ファイルでは、空の配列はサポートされていません。 詳細は、サンプルのJSONファイルにおける空の配列の非サポートを参照してください。 Adapter Endpoint Configuration Wizardを使用する前に、大きなJSONサンプル・ファイルを特殊文字で処理する必要があります。 「特殊文字を使用した大規模なサンプルJSONファイルの処理」を参照してください。

  • XMLサンプル(単一のネームスペースまたはネームスペースなし): XMLドキュメントを使用してスキーマを生成するには、このオプションを選択します。
  • バイナリ: 構造化されていないインラインのペイロードで使用する - たとえば、application/octet-streamです。 ファイルの内容は保持されますが、レシーバはファイル名の拡張子などからファイルのタイプを判断する必要があります。 任意のバイト・ストリームのインターネット・メディア・タイプはapplication/octet-streamです。 一般的に使用されるタイプのリストがドロップダウン・リストに表示されます。 このリストからタイプを選択するか、「その他のメディア・タイプ」を選択してリストにないタイプを入力し、テキスト・ボックスにタイプを入力します。

    ノート: バイナリ・ペイロードのサポートは、アダプタが起動として使用される場合にのみ使用可能であり、トリガーとして使用される場合は使用できません。

Schema Location

次のいずれかの方法でスキーマ・ファイルを指定します。
  • 「Browse」をクリックして、使用するリクエスト・スキーマ・ファイルを選択します。

  • 「inline」をクリックして、JSONペイロードまたはURLをコピーしてテキスト・フィールドに貼り付けます。 完了したら「OK」をクリックします。

要素

ペイロードの構造を定義する要素を選択します。 このフィールドは、リクエスト・ペイロード・ファイルをインポートした後で表示されます。 スキーマまたはJSONサンプル・ファイルを参照して選択したら、スキーマが自動的に表示されます。 ルート要素を選択するためのコンボ・ボックスもデフォルトで表示されます。

リクエスト本文のメディア・タイプは何ですか。 (コンテンツタイプ・ヘッダー)

  • XML: ペイロードがXML形式で表示されます。

  • XML (text): ペイロードがXMLテキスト形式で表示されます。

  • JSON: ペイロードがJavaScript Object Notation (JSON)形式で表示されます。

  • URL-encoded: ペイロードがURLエンコード形式で表示されます。

  • Other Media Type: ペイロードを別の形式で表示する場合に選択します(たとえば、application/oracle.cloud+json)。 指定できるのは末尾が+jsonまたは+xmlのメディア・タイプのみです。 次のメディア・タイプは暗黙にサポートされますが、構成できません。 実行時に、リクエスト・メディア・タイプはhttp Content-Typeヘッダーの形式になります。 予期されるレスポンス・メディア・タイプはAcceptヘッダーを使用して指定されます。 すべてのサービスには、次のメディア・タイプのいずれかを使用してアクセスできます。
    • Application/XML

    • Application/JSON

エンドポイントで受け取るマルチパート添付ファイル・タイプを選択します。 このフィールドは、「リクエストはペイロードでマルチパートです」オプションを選択した場合に表示されます。
  • multipart/mixed: 添付ファイルとともにXMLまたはJSONペイロード・タイプを送信します。 たとえば、レビュー用のPDFドキュメントを電子メール内のリンクとして送信します。

  • multipart/form-data: 添付ファイルとともにXMLまたはJSONペイロード・タイプを送信します。 たとえば、HTMLフォームを作成して、画像のアップロードや送信を行います。 HTMLフォームでは、methodpostとして定義され、enctype (エンコーディング・タイプ)はmultipart/form-dataとして定義されます。 この添付ファイル・タイプを使用する場合は、ペイロードなしで添付ファイルのみを送信することもできます。

問合せパラメータをフォーム・データとしてメッセージ本文に送信
ペイロードでURLエンコードされたフォーム・データを渡す場合に選択します。 値は、「リクエスト・パラメータ」ページで定義した問合せパラメータから導出されます。 ただし、問合せパラメータを送信するかわりに、このオプションが選択された状態でメッセージ本文にフォーム・データとして送信されます。 このフィールドは、アダプタ・エンドポイント構成ウィザードで次の選択を行った場合にのみ表示されます:
  • POST動詞が「基本情報」ページで選択されました。
  • 「基本情報」ページで「このエンドポイントのリクエスト・ペイロードの構成」および「このエンドポイントのパラメータの追加および確認」オプションが選択されました。
  • 問合せパラメータが「リクエスト・パラメータ」ページで指定されました。

RESTアダプタ起動のリクエスト・ヘッダー・ページ

このエンドポイントについてRESTアダプタのリクエスト・ヘッダー・プロパティを入力します。

ノート:

標準ヘッダー名と同じカスタム・ヘッダー名を指定すると、エラーが発生します。 カスタム・ヘッダー名には必ず一意の名前を指定してください。

使用する標準HTTPリクエスト・ヘッダーを指定します。

要素 説明

Add Standard Request Headers

デフォルトのドロップダウン・リストから、使用する標準HTTPリクエスト・ヘッダーを選択します。
  • 「Add」アイコンをクリックしてさらに行を追加し、ドロップダウン・リストから、使用する標準HTTPリクエスト・ヘッダーを選択します。 選択可能な標準ヘッダーには、次のものがありますが、これらに限定されません:
    • 受入れ: レスポンス処理は、設計時に定義された静的契約に従って行われます。 動的な値は、エンドポイントに送信された値をオーバーライドします。 返されるレスポンスは、設計時に構成された「受入れ」ヘッダーと一致する必要があります。 オーバーライドされるヘッダーは、設計時に指定されたコンテンツ長のバリエーションである必要があります。
    • 認可: 動的ヘッダー値は、セキュリティ・ポリシーの一部として実行された認可をオーバーライドします。 指定されたヘッダー・プロパティに対する承認の失敗を追跡します。
    • コンテンツの長さ: RESTアダプタは常に、ターゲット・エンドポイントに渡された実際のコンテンツ長からコンテンツ長を推測します。 コンテンツはないが、ターゲット・エンドポイントで値が0のcontent-lengthヘッダーが必要な場合は、すべてのリクエスト・ヘッダーと同様に、アダプタ・エンドポイント構成ウィザードから標準HTTPリクエスト・ヘッダーを含めて、マッパーに0の値を割り当てることができます。 Oracle Integration 3では、値が0のContent-Lengthヘッダーは、コンテンツのないPUTおよびPATCH動詞に対してのみ送信されます。
    • Content-Type: 動的ヘッダーは翻訳フレームワークに渡されず、設計時に静的構成に従って翻訳が続行されます。 実行時(メッセージ後処理)に、動的ヘッダー値がエンドポイントに送信されます。
    • : 送信元リクエスト・ヘッダーは、送信HTTPリクエストの一部として設定できます。
  • 「Delete」アイコンをクリックして、選択した標準HTTPリクエスト・ヘッダーの行を削除します。

HTTP Header Name

次のタスクを実行します。
  • リストから、使用するヘッダーを選択します。

使用するカスタムHTTPリクエスト・ヘッダーを指定します。

要素 説明

Add Custom Request Headers

次のカスタム・リクエスト・ヘッダー・タスクを実行します。
  • 「Add」アイコンをクリックして、カスタムHTTPリクエスト・ヘッダーおよび説明(オプション)を追加します。

  • 「Delete」アイコンをクリックして、選択したカスタムHTTPリクエスト・ヘッダーを削除します。

Custom Header Name

カスタム・ヘッダー名を入力します。

Custom Header Description

オプションで説明を入力します。

RESTアダプタ起動レスポンス・ページ

エンドポイントについてRESTアダプタのレスポンス・ペイロードの詳細を入力します。

要素 説明

Resource URI

Basic Infoページに入力された、エンドポイントの相対URIが表示されます。

HTTPメソッド 「基本情報」ページで選択したエンドポイントで実行するアクションが表示されます。

マルチパート添付処理オプションの選択

リクエストがインバウンドとアウトバウンドのいずれであるかに基づいて、次のオプションを構成します。

インバウンド(トリガー)・レスポンスについて、含めるマルチパート添付ファイル・タイプを選択します。

  • レスポンスはペイロードでマルチパートです: ペイロードからレスポンスを受信する場合に選択します。

  • マルチパート・レスポンスのタイプはmultipart/form-dataで、HTMLフォーム・ペイロードがあります: RESTエンドポイントでHTMLフォームの構成を受け入れる場合に選択します。 このオプションを選択する前に、まず「レスポンスはペイロードでマルチパートです」オプションを選択する必要があります。 この選択はメディア・タイプがmultipart/form-dataであることを前提とします。

レスポンス・ペイロード書式を選択

ノート:
  • サンプルJSONまたはアップロードされたXMLスキーマが、エンドポイントと交換された実際のランタイム・メッセージを表すことを確認してください。 ランタイム・メッセージの構造またはタイプが一致しないと、エラーが発生する可能性があります。

  • ターゲット名前空間なしでスキーマ・ファイルをアップロードすると、すべてのメッセージが使用するスキーマ・ファイルにサロゲート名前空間が追加されます:
    http://xmlns.oracle.com/cloud/adapter/nxsd/surrogate
使用するレスポンス・ペイロード形式を選択します。 レスポンス・ペイロードの主要部は、表現の構造をXSD要素を使用して定義する必要があります。
  • XMLスキーマ

  • JSONサンプル: SwaggerファイルとRAMLファイルを使用するには、このオプションを選択します。 最大100KBのサイズのJSONサンプル・ファイルがサポートされています。

    JSONサンプル・ファイルでは、空の配列はサポートされていません。 詳細は、サンプルのJSONファイルにおける空の配列の非サポートを参照してください。 Adapter Endpoint Configuration Wizardを使用する前に、大きなJSONサンプル・ファイルを特殊文字で処理する必要があります。 「特殊文字を使用した大規模なサンプルJSONファイルの処理」を参照してください。
  • XMLサンプル(単一のネームスペースまたはネームスペースなし): XMLドキュメントを使用してスキーマを生成するには、このオプションを選択します。
  • バイナリ: 構造化されていないインラインのペイロードで使用する - たとえば、application/octet-streamです。 ファイルの内容は保持されますが、レシーバはファイル名の拡張子などからファイルのタイプを判断する必要があります。 任意のバイト・ストリームのインターネット・メディア・タイプはapplication/octet-streamです。

Schema Location

次のいずれかの方法でスキーマ・ファイルを指定します。

  • 「Browse」をクリックして、使用するレスポンス・スキーマ・ファイルを選択します。

  • 「inline」をクリックして、JSONペイロードまたはURLをコピーしてテキスト・フィールドに貼り付けます。 完了したら「OK」をクリックします。

要素

ペイロードの構造を定義する要素を選択します。 このフィールドは、レスポンス・ペイロード・ファイルをインポートした後で表示されます。 スキーマ・ファイルを参照して選択すると、ルート要素を選択するためのコンボ・ボックスがデフォルトで表示されます。

レスポンス本文のメディア・タイプは何ですか。 (受入れヘッダー)

エンドポイントで応答するペイロードのタイプを選択します。
  • XML: ペイロードがXML形式で表示されます。

  • XML (text): ペイロードがXMLテキストで表示されます。

  • JSON: ペイロードがJavaScript Object Notation (JSON)形式で表示されます。

  • Other Media Type: ペイロードを別の形式で表示する場合に選択します(たとえば、application/oracle.cloud+json)。 指定できるのは末尾が+jsonまたは+xmlのメディア・タイプのみです。 次のメディア・タイプは暗黙にサポートされますが、構成できません。 実行時に、リクエスト・メディア・タイプはhttp Content-Typeヘッダーの形式になります。 予期されるレスポンス・メディア・タイプはAcceptヘッダーを使用して指定されます。 すべてのサービスには、次のメディア・タイプのいずれかを使用してアクセスできます。
    • Application/XML

    • Application/JSON

エンドポイントで受け取るマルチパート添付ファイル・タイプを選択します。 このフィールドは、「レスポンスはペイロードでマルチパートです」オプションを選択した場合に表示されます。
  • multipart/mixed: 添付ファイルとともにXMLまたはJSONペイロード・タイプを送信します。 たとえば、レビュー用のPDFドキュメントを電子メール内のリンクとして送信します。

  • multipart/form-data: 添付ファイルとともにXMLまたはJSONペイロード・タイプを送信します。 たとえば、HTMLフォームを作成して、画像のアップロードや送信を行います。 HTMLフォームでは、methodpostとして定義され、enctype (エンコーディング・タイプ)はmultipart/form-dataとして定義されます。

RESTアダプタ起動レスポンス・ヘッダー・ページ

このエンドポイントについてRESTアダプタのレスポンス・ヘッダー・プロパティを入力します。

ノート:

標準ヘッダー名と同じカスタム・ヘッダー名を指定すると、エラーが発生します。 カスタム・ヘッダー名には必ず一意の名前を指定してください。

使用する標準HTTPレスポンス・ヘッダーを指定します。

要素 説明

Add Standard Response Headers

デフォルトのドロップダウン・リストから、使用する標準HTTPレスポンス・ヘッダーを選択します。
  • 「Add」アイコンをクリックしてさらに行を追加し、ドロップダウン・リストから、使用する標準HTTPレスポンス・ヘッダーを選択します。 選択可能な標準ヘッダーには、次のものがありますが、これらに限定されません:
    • コンテンツの長さ: レスポンスのコンテンツ長は、長さに関係なくOracle Integrationに伝播されます。 レスポンスが翻訳され、実際の値が一致しなくなった可能性があります。 これは、元のメッセージに対応するレスポンス・ヘッダーです。
    • Content-Type: レスポンス・ヘッダーは、レスポンスとともに統合に伝播されます。
    • Retry-After: ターゲット・エンドポイントによって送信されたレスポンス・ヘッダーが統合に返されます。
  • 「Delete」アイコンをクリックして、選択した標準HTTPレスポンス・ヘッダーの行を削除します。

HTTP Header Name

次のタスクを実行します。
  • リストから、使用するヘッダーを選択します。

使用するカスタムHTTPレスポンス・ヘッダーを指定します。

要素 説明

Add Custom Response Headers

次のカスタム・レスポンス・ヘッダー・タスクを実行します。
  • 「Add」アイコンをクリックして、カスタムHTTPレスポンス・ヘッダーおよび説明(オプション)を追加します。

  • 「Delete」アイコンをクリックして、選択したカスタムHTTPレスポンス・ヘッダーを削除します。

Custom Header Name

カスタム・ヘッダー名を入力します。

Custom Header Description

オプションで説明を入力します。

RESTアダプタ起動操作選択ページ

このエンドポイントについてRESTアダプタの呼出し操作選択パラメータを入力します。

要素 説明

Business Object

この接続で使用するビジネス・オブジェクト(リソース)を選択します。

Operations

この接続のビジネス・オブジェクトに対して実行する操作(メソッド)を選択します。

サマリー・ページ

指定したアダプタ構成値は、Summaryページで確認できます。

要素 説明

サマリー

ウィザードのそれまでのページで定義した構成の値のサマリーが表示されます。

表示される情報は、アダプタによって異なる場合があります。 一部のアダプタでは、選択したビジネス・オブジェクトおよび操作名が表示されます。 生成されたXSDファイルが提供されるアダプタの場合は、XSDリンクをクリックしてそのファイルの読取り専用バージョンを表示します。

前のページに戻って値を更新するには、左パネルの適切なタブをクリックするか、「戻る」をクリックします。

構成の詳細を取り消すには、「取消」をクリックします。

「サンプルcURLの生成」をクリックして、RESTアダプタの接続構成時に選択した構成オプション(セキュリティ・ポリシー、ヘッダー、パラメータなど)のサンプルcURL構文を生成します。