PUT実行処理
オペレーション名
PUT実行
機能概要
HTTPのPUTメソッドでリクエストを実行します。
プロパティ
変数の使用については、「変数」を参照してください。
基本設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
名前 |
必須 |
使用不可 |
スクリプトキャンバス上での名前を入力します。 |
|
|
入力データ |
省略可 |
使用不可 |
スクリプトキャンバス上にあるコンポーネントを選択します。 |
|
必須設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
接続先 |
必須 |
使用不可 |
コネクションリソースを選択します。
|
|
|
パス |
省略可 |
使用可 |
[接続先]の[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ヘッダのうち、取得したいヘッダの名前を指定します。 各レスポンスヘッダは以下のボタンで操作することができます。
|
|
|
レスポンスヘッダ/名前 |
省略可 |
環境変数のみ使用可 |
レスポンスヘッダの名前を入力します。 |
|
認証設定
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
認証 |
必須 |
使用不可 |
リクエスト送信時の認証方式を選択します。
|
|
|
ユーザ |
省略可 |
使用可 |
認証に使用するユーザ名を入力します。 |
|
|
パスワード |
省略可 |
使用可 |
認証に使用するパスワードを入力します。 |
|
|
接続先 |
省略可 |
使用不可 |
認証に使用するコネクションリソースを選択します。 |
|
データ処理方式
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
データ処理方式 |
省略可 |
使用不可 |
データ処理方式を選択します。
|
|
コメント
|
項目名 |
必須/省略可 |
変数の使用 |
説明 |
備考 |
|---|---|---|---|---|
|
コメント |
省略可 |
使用不可 |
このコネクターの簡単な説明を記述することができます。 |
|
[リクエスト設定]の[データ形式]の設定により、スキーマが異なります。
[XML]の場合
リクエストボディのXMLデータによって異なります。
リクエストボディがJSON形式のデータの場合、入力データをXML形式からJSON形式に変換して処理されます。
JSON形式のデータに変換するためのXML形式のスキーマは以下のとおりです。
<--ルートがオブジェクト型の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 のデータ> --<バウンダリ>--
[レスポンス設定]の[データ形式]の設定により、スキーマが異なります。
[XML]の場合
レスポンスボディのXMLデータによって異なります。
[JSON]の場合
レスポンスボディがJSON形式のデータの場合、XML形式に変換されて結果データに出力されます。
JSON形式からXML形式に変換した場合のスキーマは以下のとおりです。
<--ルートがオブジェクト型の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ヘッダの値によってデータが変わります。
|
Mapperでの入力スキーマ読み込み
[リクエスト設定]の[データ形式]の設定により、入力スキーマの読み込みが異なります。
[XML]の場合
スキーマは手動で読み込む必要があります。
読み取りを行うデータのスキーマを指定してください。
[JSON]の場合
[JSONファイルを指定して入力スキーマを設定]で設定した場合、スキーマは自動で読み込まれます。
[フォーム]の場合
スキーマは自動で読み込まれます。
Mapperでの出力スキーマ読み込み
[レスポンス設定]の[データ形式]の設定により、出力スキーマの読み込みが異なります。
[XML]の場合
スキーマは手動で読み込む必要があります。
読み取りを行うデータのスキーマを指定してください。
[JSON]の場合
[JSONファイルを指定して出力スキーマを設定]で設定した場合、スキーマは自動で読み込まれます。
大容量データ処理
大容量データ処理に対応しています。
トランザクション
トランザクションはサポートしていません。
PSPでの使用について
PSPでは使用できません。
|
コンポーネント変数名 |
説明 |
備考 |
|---|---|---|
|
status_code |
レスポンスのHTTPステータスコードが格納されます。 |
|
|
reason_phrase |
レスポンスのHTTPステータスコードに関連したテキストフレーズが格納されます。 |
|
|
error_response_body |
レスポンスのステータスコードが「4xx」または「5xx」の場合のレスポンスボディが格納されます。 |
|
|
message_category |
エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。 |
|
|
message_code |
エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。 |
|
|
message_level |
エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。 |
|
|
error_type |
エラー発生時、発生したエラーの種類が格納されます。 |
|
|
error_message |
エラー発生時、発生したエラーのメッセージが格納されます。 |
|
|
error_trace |
エラー発生時、発生したエラーのトレース情報が格納されます。 |
|
[自動でリダイレクトする]にチェックを入れた場合の挙動は以下になります。
レスポンスのステータスコードが以下のいずれかに該当する場合、レスポンスの「Location」ヘッダで示されるURIに対してリクエストを再送信します。リダイレクト先のホスト名に英大文字が入っていた場合、小文字に変換してリダイレクトを行います。
- 301
-
(Moved Permanently)
- 302
-
(Found)
- 303
-
(See Other)
- 307
-
(Temporary Redirect)
レスポンスのステータスコードが400以上の場合の結果データについて
レスポンスのステータスコードが400以上の場合の場合、レスポンスボディを結果データに出力します。
その際、レスポンスのContent-Typeヘッダの値によって結果データのスキーマが異なります。
-
Content-Typeヘッダのサブタイプが「xml」で終わる場合
レスポンスボディのXMLデータによって異なります。
-
Content-Typeヘッダのサブタイプが「json」で終わる場合
「[JSON]の場合」になります。
-
上記のいずれにも該当しない場合
「[その他のデータ形式]の場合」になります。
= 備考 =content要素内容は、以下の規則にしたがってエンコーディングされたレスポンスボディが出力されます。
-
レスポンスヘッダにContent-Typeヘッダがある場合、Content-Typeヘッダのcharsetパラメータの値でエンコーディングされます。
-
レスポンスヘッダにContent-Typeヘッダがない、またはContent-Typeヘッダにcharsetパラメータがない場合、「ISO-8859-1」でエンコーディングされます。
-
メッセージコード、例外メッセージ、制限事項
|
コネクター |
メッセージコード |
例外メッセージ |
制限事項 |
|---|---|---|---|
>