項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考 |
---|---|---|---|---|
名前 | 必須 | 使用不可 | スクリプトキャンバス上での名前を入力します。 | |
入力データ | 省略可 | 使用不可 | スクリプトキャンバス上にあるコンポーネントを選択します。 |
|
項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考 |
---|---|---|---|---|
接続先 | 必須 | 使用不可 | グローバルリソースを選択します。
グローバルリソースの設定方法については、「グローバルリソースのプロパティ」を参照してください。
|
|
パス | 省略可 | 使用可 | [接続先]の[URL]に入力したURLからの相対パスを指定します。 |
|
エンコード | 省略可 | 使用可 | URLエンコーディングに使用するエンコードを選択または入力します。
入力する場合は、Java SE Runtime Environment 8でサポートされているエンコードを指定します。 詳細については、「Supported Encodings」(http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html)を参照してください。 |
|
クエリパラメータ | 省略可 | - | URLに連結させるクエリパラメータの名前と値を指定します。
各クエリパラメータは以下のボタンで操作することができます。
|
|
クエリパラメータ/名前 | 省略可 | 使用可 | クエリパラメータの名前を入力します。 |
|
クエリパラメータ/値 | 省略可 | 使用可 | クエリパラメータの値を入力します。 |
項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考 |
---|---|---|---|---|
データ入力元 | 必須 | 使用不可 | リクエストボディの入力元を選択します。
|
|
データ形式 | 必須 | 使用不可 | リクエストボディのデータ形式を選択します。
|
|
ファイルパス | 必須 | 使用可 | リクエストボディの入力元となるファイルのパスを選択または入力します。
[参照]ボタンを押下するとファイルチューザが起動し、ファイルの選択ができます。 |
|
フォーム設定 | 省略可 | - | リクエストボディとなるフォームのパラメータを指定します。
各パラメータは以下のボタンで操作することができます。
|
|
フォーム設定/名前 | 省略可 | 環境変数のみ使用可 | フォーム名を入力します。 | |
マルチパートフォーム設定 | 省略可 | - | リクエストボディとなるマルチパートを指定します。
各パートは以下のボタンで操作することができます。
|
|
マルチパートフォーム設定/名前 | 省略可 | 環境変数のみ使用可 | マルチパートのパート名を入力します。 | |
マルチパートフォーム設定/種類 | 省略可 | 使用不可 | マルチパートのパートの種類を選択します。
|
|
種類がファイルの場合パートヘッダにContent-Lengthヘッダを付与する | 省略可 | 使用不可 | [マルチパートフォーム設定/種類]が[ファイル]の場合、入力データで指定したファイルのサイズを値として、パートヘッダにContent-Lengthヘッダを付与するかどうかを選択します。
|
|
項目名 | 説明 | 備考 |
---|---|---|
JSONファイルを指定してスキーマを設定 | JSONファイルを指定して入力元のスキーマを設定します。 | [データ形式]に[JSON]を選択した場合、表示されます。 |
項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考 |
---|---|---|---|---|
データ出力先 | 必須 | 使用不可 | レスポンスボディの出力先を選択します。
|
|
データ形式 | 必須 | 使用不可 | レスポンスボディのデータ形式を選択します。
|
|
ファイルパス | 必須 | 使用可 | レスポンスボディを出力するファイルのパスを選択または入力します。
[参照]ボタンを押下するとファイルチューザが起動し、ファイルの選択ができます。 |
|
XMLとして不正な文字を削除する | 省略可 | 使用不可 | JSON形式のデータの解析中にXMLとして不正な文字列が見つかった場合に自動で削除するかどうかを選択します。
|
|
自動でリダイレクトする | 省略可 | 使用不可 |
レスポンスにリダイレクト先が含まれている場合、自動でリダイレクトするかどうかを選択します。
|
|
レスポンスのステータスコードが4xx、5xxの場合エラーにする | 省略可 | 使用不可 |
レスポンスのステータスコードが「4xx」または「5xx」の場合、処理をエラーにするかどうかを選択します。
|
項目名 | 説明 | 備考 |
---|---|---|
JSONファイルを指定してスキーマを設定 | JSONファイルを指定して出力先のスキーマを設定します。 | [データ形式]に[JSON]を選択した場合、表示されます。 |
項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考 |
---|---|---|---|---|
リクエストヘッダ | 省略可 | - | リクエストに含めるHTTPヘッダを指定します。
各リクエストヘッダは以下のボタンで操作することができます。
|
|
リクエストヘッダ/名前 | 省略可 | 使用可 | リクエストヘッダの名前を入力します。 |
|
リクエストヘッダ/値 | 省略可 | 使用可 | リクエストヘッダの値を入力します。 | |
レスポンスヘッダ | 省略可 | - | レスポンスに含まれるHTTPヘッダのうち、取得したいヘッダの名前を指定します。
各レスポンスヘッダは以下のボタンで操作することができます。
|
|
レスポンスヘッダ/名前 | 省略可 | 環境変数のみ使用可 | レスポンスヘッダの名前を入力します。 |
|
項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考 |
---|---|---|---|---|
認証 | 必須 | 使用不可 | リクエスト送信時の認証方式を選択します。
|
|
ユーザ | 省略可 | 使用可 | 認証に使用するユーザ名を入力します。 |
|
パスワード | 省略可 | 使用可 | 認証に使用するパスワードを入力します。 |
|
グローバルリソース | 省略可 | 使用不可 | 認証に使用するグローバルリソースを選択します。 |
|
項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考 |
---|---|---|---|---|
データ処理方式 | 省略可 | 使用不可 | データ処理方式を選択します。
|
項目名 | 必須/省略可 | 変数の使用 | 説明 | 備考 |
---|---|---|---|---|
コメント | 省略可 | 使用不可 | このアダプタの簡単な説明を記述することができます。 説明を記述すると、仕様書に反映させることができます。 |
<--ルートがオブジェクト型のJSONオブジェクトの場合 --> <?xml version="1.0"?> <root type="object"> <JSONメンバの名前 type="JSONの型を表す属性値">値</JSONメンバの名前> : </root> <-- ルートが配列型のJSONオブジェクトの場合 --> <?xml version="1.0"?> <root type="array"> <element type="JSONの型を表す属性値">値</element> : </root> <-- JSONメンバの名前がXMLの要素名として不正な場合 --> <?xml version="1.0"?> <root type="object"> <member type="JSONの型を表す属性値" name="JSONメンバの名前">値</member> : </root>
要素名 | 属性名 | 説明 | 備考 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
root | - | JSONオブジェクトをラップするルート要素です。 | ||||||||||||||
type | JSONの型を表す属性値を指定します。
|
|
||||||||||||||
JSONメンバの名前 | - | JSONメンバを表す要素です。 | ||||||||||||||
type | JSONの型を表す属性値を指定します。
|
|
||||||||||||||
element | - | 配列の要素を表す要素です。 | ||||||||||||||
type | JSONの型を表す文字列を指定します。
JSONメンバの名前のtype属性と同じ属性値を指定します。 |
|
||||||||||||||
member | - | JSONメンバの名前がXMLの要素名として不正な場合、代わりに指定する要素です。 | ||||||||||||||
type | JSONの型を表す文字列が出力されます。
JSONメンバの名前のtype属性と同じ属性値を指定します。 |
|
||||||||||||||
name | JSONメンバの名前を指定します。
例:member要素を指定してname属性値にJSONメンバの名前を指定したXMLデータ <member type="string" name="1name">Suzuki</member>上記例のXMLデータは以下のJSONメンバに変換されます。 {"1name":"Suzuki"} |
|
<?xml version="1.0"?> <request> <body> <form> <フォームのパラメータ名> <value>フォームのパラメータ値</value> </フォームのパラメータ名> : <-- フォームのパラメータ名がXMLの要素名として不正な場合 --> <parameter name="フォームのパラメータ名"> <value>フォームのパラメータ値</value> </parameter> : </form> </body> </request>
要素名 | 属性名 | 説明 | 備考 |
---|---|---|---|
request | - | ||
body | - | ||
form | - | ||
フォームのパラメータ名 | - | フォームのパラメータ名を表す要素です。 |
|
parameter | - | フォームのパラメータ名がXMLの要素名として不正な場合の要素です。 |
|
name | フォームのパラメータ名を入力します。 |
|
|
value | - | フォームのパラメータ値を入力します。 |
|
<?xml version="1.0"?> <request> <body> <form> <firstname> <value>一朗</value> </firstname> <lastname> <value>鈴木</value> </lastname> </form> </body> </request>上記XMLデータの場合、リクエストボディに格納されるフォームデータは以下のようになります。
Content-Type: application/x-www-form-urlencoded; charset="UTF-8" firstname=%E4%B8%80%E6%9C%97&lastname=%E9%88%B4%E6%9C%A8
<?xml version="1.0"?> <request> <body> <multipart> <-- 種類が「文字列」の場合 --> <パート名> <value>フォームの値</value> <mimeType>パートのContent-Typeヘッダに入るMIMEタイプ</mimeType> </パート名> : <-- 種類が「ファイル」の場合 --> <パート名> <file> <path>ファイルのパス</path> </file> <mimeType>パートのContent-Typeヘッダに入るMIMEタイプ</mimeType> </パート名> : <-- パート名がXMLの要素名として不正な場合 --> <part name="パート名"> <value>パートの値</value> <mimeType>パートのContent-Typeヘッダに入るMIMEタイプ</mimeType> </part> : </multipart> </body> </request>
要素名 | 属性名 | 説明 | 備考 |
---|---|---|---|
request | - | ||
body | - | ||
multipart | - | ||
パート名 | - | パート名を表す要素です。 |
|
part | - | パート名がXMLの要素名として不正な場合の要素です。 |
|
name | パート名を入力します。 |
|
|
mimeType | - | パートのContent-Typeヘッダに入るMIMEタイプを入力します。 |
|
value | - | パートのボディとなる文字列を入力します。 |
|
file | - | ||
path | - | パートのボディとなるファイルのパスを入力します。 |
|
<?xml version="1.0"?> <request> <body> <multipart> <firstname> <value>Ichiro</value> </firstname> <lastname> <value>Suzuki</value> </lastname> <attachment> <file> <path>/data/profile.jpg</path> </file> </attachment> </multipart> </body> </request>上記XMLデータの場合、リクエストボディに格納されるマルチパートフォームデータは以下のようになります。
Content-Type: multipart/form-data; boundary=<バウンダリ> --<バウンダリ> Content-Disposition: form-data; name="firstname" Ichiro --<バウンダリ> Content-Disposition: form-data; name="lastname" Suzuki --<バウンダリ> Content-Disposition: form-data; name="attachment"; filename="profile.jpg" Content-Type: image/jpeg </data/profile.jpg のデータ> --<バウンダリ>--
<--ルートがオブジェクト型のJSONオブジェクトの場合 --> <?xml version="1.0"?> <root type="object"> <JSONメンバの名前 type="JSONの型を表す属性値">値</JSONメンバの名前> : </root> <-- ルートが配列型のJSONオブジェクトの場合 --> <?xml version="1.0"?> <root type="array"> <element type="JSONの型を表す属性値">値</element> : </root> <-- JSONメンバの名前がXMLの要素名として不正な場合 --> <?xml version="1.0"?> <root type="object"> <member type="JSONの型を表す属性値" name="JSONメンバの名前">値</member> : </root>
要素名 | 属性名 | 説明 | 備考 | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
root | - | JSONオブジェクトをラップするルート要素です。 | ||||||||||||||
type | JSONの型を表す属性値が設定されます。
|
|||||||||||||||
JSONメンバの名前 | - | JSONメンバを表す要素です。 | ||||||||||||||
type | JSONの型を表す属性値が設定されます。
|
|||||||||||||||
element | - | 配列の要素を表す要素名です。 | ||||||||||||||
type | JSONの型を表す文字列が出力されます。
JSONメンバの名前のtype属性と同じ属性値が設定されます。 |
|||||||||||||||
member | - | JSONメンバの名前がXMLの要素名として不正な場合に使われる要素名です。 | ||||||||||||||
type | JSONの型を表す文字列が出力されます。
JSONメンバの名前のtype属性と同じ属性値が設定されます。 |
|||||||||||||||
name | JSONメンバの名前が出力されます。
例:XMLの要素名として不正な名前を持つJSONメンバ {"1name":"Suzuki"}上記例のJSONメンバは以下のXMLデータに変換されて出力されます。 <member type="string" name="1name">Suzuki</member> |
<?xml version="1.0"?> <response> <body> <content>レスポンスボディのデータ</content> </body> </response>
要素名 | 属性名 | 説明 | 備考 |
---|---|---|---|
response | - | ||
body | - | ||
content | - | レスポンスボディのデータです。 |
レスポンスのContent-Typeヘッダの値によってデータが変わります。
|
コンポーネント変数名 | 説明 | 備考 |
---|---|---|
status_code | レスポンスのHTTPステータスコードが格納されます。 |
|
reason_phrase | レスポンスのHTTPステータスコードに関連したテキストフレーズが格納されます。 |
|
error_response_body | レスポンスのステータスコードが「4xx」または「5xx」の場合のレスポンスボディが格納されます。 |
|
message_category | エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。 |
|
message_code | エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。 |
|
message_level | エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。 |
|
error_type | エラー発生時、発生したエラーの種類が格納されます。 |
|
error_message | エラー発生時、発生したエラーのメッセージが格納されます。 |
|
error_trace | エラー発生時、発生したエラーのトレース情報が格納されます。 |
|
例外名 | 原因 | 対策 |
---|---|---|
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[] |
[接続先]が指定されていません。 | [接続先]を指定してください。 |
ResourceNotFoundException リソース定義が見つかりませんでした。名前:[<グローバルリソース名>] |
[接続先]で選択されたリソース定義が見つかりません。 | [接続先]で指定したグローバルリソースを確認してください。 |
InvalidPropertyConfigurationException リソースの必須項目が指定されていません。:<プロパティ名> |
[接続先]の[<プロパティ名>]が指定されていません。 | [接続先]の[<プロパティ名>]を指定してください。 |
InvalidPropertyConfigurationException
<プロパティ名>が指定されていません。 |
[<プロパティ名>]が指定されていません。 | [<プロパティ名>]を指定してください。 |
FileIsDirectoryException | [ファイルパス]に入力されたパスがディレクトリです。 | [ファイルパス]にはファイルパスを入力してください。 |
PathIsNotAbsoluteException | [パス]または[ファイルパス]に入力されたパスが相対パスです。 | [パス]または[ファイルパス]には絶対パスを入力してください。 |
PathIsRequiredException | マルチパートフォームデータの送信時に、パートのボディに格納するデータのファイルを示すパスが入力データに設定されていません。 | 入力データのpath要素にパスが設定されているか確認してください。 |
RestServerException | HTTPサーバからステータスコードが「5xx」のレスポンスが返されました。 | エラーメッセージの内容を参考に[接続先]に指定しているHTTPサーバの状態やリクエストの内容を確認してください。 |
RestClientException | HTTPサーバからステータスコードが「4xx」のレスポンスが返されました。 | エラーメッセージの内容を参考に[パス]で入力したパスやリクエストの内容を確認してください。 |
org.apache.http.client.ClientProtocolException | リクエスト送信時にエラーが発生しました。 | エラーメッセージの内容を確認してください。 |
org.apache.http.conn.HttpHostConnectException | HTTPサーバまたはプロキシサーバに接続できませんでした。 | 接続先のHTTPサーバまたはプロキシサーバに接続可能かどうか確認してください。 |
org.apache.http.conn.ConnectTimeoutException | HTTPサーバまたはプロキシサーバとの接続時にタイムアウトが発生しました。 | [接続先]の[接続タイムアウト]の設定を確認してください。 |
java.net.SocketTimeoutException | HTTPサーバに接続後、リクエストを送信してからレスポンスを受信するまでの応答でタイムアウトが発生しました。 | [接続先]の[応答タイムアウト]の設定を確認してください。 |
javax.json.stream.JsonParsingException | レスポンスボディをJSON形式として処理中にエラーが発生しました。 | エラーメッセージの内容を参考に[レスポンス設定]の設定とレスポンスの内容を確認してください。 |
javax.json.stream.JsonGenerationException | 入力データをJSON変換処理中にエラーが発生しました。 | 入力データの内容を確認してください。 |