Home > コンポーネント シリーズ > REST クライアント > REST クライアント - 設定 > REST クライアント - XML
RESTクライアントコンポーネントを使用すると、ユーザはMagic xpiフローからRESTful Webサービスを呼び出すことができます。RESTクライアントコンポーネントをステップとしてフローに配置すると、[プロパティ]ペインが開きます。コンポーネントをダブルクリックするか、右クリックしてコンテキストメニューから[設定]を選択し、[RESTクライアント設定]ダイアログボックスを開きます。
このダイアログボックスには以下のフィールドが含まれています。
プロパティ |
説明 |
||
接続 |
|||
リソース名 |
コネクタの［プロパティ］ペインで選択されたRESTクライアントリソースの名前。リソースは、［設定］ダイアログボックスの［リソース］セクションで定義されます。 |
||
オペレーション |
|||
パス |
ドロップダウンリストからRESTパスを選択します。リストはリソースから生成されます。選択されたパスはエンドポイントのRESTfulリソース（エンティティ）から使用されます。 |
||
オペレーション |
ドロップダウンリストから以下のオペレーションのどれかを選択してください。
|
||
セキュリティ |
REST呼び出し呼び出しに関連付けるセキュリティーを選択してください。セキュリティオプションは、RESTクライアントリソース設定の一部として設定されます。 デフォルト値は、Yesです。特に指定しない限り、REST呼び出しは保護されます。 たとえば、セキュリティが必要な場合のPostオペレーションの場合は値をYesに設定し、RESTオペレーションを呼び出すうえでセキュリティが必要ない場合のGetオペレーションではNoに設定します。 |
||
リクエストContent-Type |
RESTリクエストの一部として送信されるリクエストのコンテンツタイプを選択します。これにより、Content-TypeというHTTPヘッダが設定されます。
デフォルトのリストには、以下のコンテンツタイプが含まれています。
|
||
レスポンス Content-Type |
RESTレスポンスの一部として受信するレスポンスのコンテンツタイプを選択します。これにより、AcceptというHTTPヘッダが設定されます。
デフォルトのリストには、以下のコンテンツタイプが含まれています。
|
||
エンコーディング |
RESTリクエストの一部として送信されるデータのエンコードを選択してください。エンコーディングは、データを選択されたエンコーディングタイプに変換します。このシナリオでは（Keep Existingを除く）、HTTPヘッダのContent-TypeはCharsetオプションが含まれます。 例えば、目的のエンコーディングがUTF-8として選択され、リクエスト Content-Typeがapplication/jsonとして選択されている場合、Content-Type HTTP Headerは"Content-Type = application/json; Charset = UTF-8"として設定されます。 デフォルト値はKeep Existingです。この場合、ユーザはCharsetの値を指定することができます。 サポートされているエンコーディング値は、Keep Existing、BOM付きUTF-8、UTF-8、Unicode、Ansi、Binaryです。 実行時の変換はデータBLOBに対して行われます。参照：REST クライアント- 変換テーブル
|
||
文字セット |
|
||
出力 |
|||
結果を保存 |
これはRESTful APIによって送信された結果です。 結果をファイルと変数のどちらに格納するかを定義します。ドロップダウンリストから、以下のどれかを選択してください。
|
||
ヘッダフィルタ |
レスポンスヘッダのテキストまたはREST ボディヘッダに追加される式を入力します。 ヘッダはコンマ（.）で区切ります。いずれかのヘッダ値にコンマ（.）が含まれている場合は、値をバックスラッシュでエスケープする必要があります。 ヘッダが指定されていない場合、またはフィールドが空白のままの場合は、デフォルトですべてのヘッダがヘッダフィールドに保存されます。 |
||
ヘッダ |
ヘッダフィルタによってフィルタされたヘッダはここでのみ利用可能になります。 プロジェクトの実行中にヘッダ情報を保存するには、Header変数の設定が必須となります。 |
||
ステータスコード |
これはRESTリクエストによって返されるHTTPレスポンスコードです。 例えば、200、201、401などです。 |
||
メッセージ |
これはRESTリクエストによって返されるHTTPレスポンスメッセージです。 たとえば、OK、Created、Unauthorizedなどです。 |
||
処理成功 |
このフィールドは、データオブジェクトがREST呼び出しで正常に検索されたかどうかを容易に定義できます。ドロップダウンリストから以下のどれかを選択してください。
|
||
［RESTクライアント設定］ダイアログボックスには、以下の追加ボタンがあります。
ボタン |
内容 |
||
パラメーター |
[パラメータ]ボタンを使用すると、REST呼び出しごとにヘッダおよびクエリパラメータの値を設定することができます。 [パラメータ]ボタンをクリックすると、[パラメータ設定]ダイアログボックスが開き、選択したRESTクライアントリソースから継承したデフォルトパラメータの値を上書きすることができます。
パラメータ設定の詳細については、ここをクリックしてください。 パスパラメータの一部として記述された特殊文字は常にエンコードされます。magic.iniのフラグ[MAGIC_IBOLT]RestClientPathParamURIEncodeを使用すると、この動作をやめることができます。（Since version: 4.13.1） |
||
スキーマをリフレッシュ |
［スキーマのリフレッシュ］ボタンは、RESTクライアントコンポーネントのフォームパラメータをRESTクライアントリソースと同期させます。 ［スキーマのリフレッシュ]ボタンをクリックすると、現在のスキーマが上書きされ、RESTクライアントリソースの設定と同期されます。 生成されたスキーマは、データマッパーのフォームパラメータを反映するために使用されます。 データマッパー送り先タブでは、ユーザはフォームパラメータのこれらの値を設定することができます |
[OK]をクリックするとRESTクライアントの設定は完了します。スキーマが存在しない場合は、RESTクライアントリソースの設定に従ってスキーマが作成されます。設定情報が保存され、選択したスキーマを[送り先]として[データマッパー]ウィンドウが開きます。ここで、ユーザーはFormパラメーターに必要な値をマッピングすることで、RESTクライアントで目的の処理を完了することができます。
[キャンセル]をクリックすると、設定や変更を保存されずに[RESTクライアント設定]ダイアログボックスを終了します。
をクリックしてコンテンツタイプを開きます。ユーザは他のコンテンツタイプを選択することができます。
をクリックして式エディタを開きます。
をクリックしてこの情報が格納されるファイルパスを入力してください。