Item name | Required/Optional | Use of Variables | Description | Remarks |
---|---|---|---|---|
Name | Required | Not available | Enter the name to show on the script canvas. | |
Input data | Optional | Not available | Select the component on the script canvas. |
|
Item name | Required/Optional | Use of Variables | Description | Remarks |
---|---|---|---|---|
Destination | Required | Not available | Select a global resource. For how to set a global resource, please refer to "Global resource property"."
|
|
Path | Optional | Available | Specify the relative path from the URL entered in [URL] of [Destination]. |
|
Encoding | Optional | Available | Select or enter the encodes to use in URL Encoding.
Specify the encodes supported by Java SE Runtime Environment 8 when inputting. For details, please refer to "Supported Encodings"(http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html). |
|
Query parameters | Optional | - | Specify the name and the value of a parameter linking to the URL.
Each parameter can be operated with the following.
|
|
Query parameters/ Name | Optional | Available | Enter the name of a query parameter. |
|
Query parameters/ Value | Optional | Available | Enter the value of a query parameter. |
Item name | Required/Optional | Use of Variables | Description | Remarks |
---|---|---|---|---|
Input source | Required | Not available | Select the input source of the request body.
|
|
Data type | Required | Not available | Select the data type of the request body.
MIME type of the Content-Type header becomes "application/xml". MIME type of the Content-Type header becomes "application/json". |
|
File path | Required | Available | Select or enter the file path that outputs request body.
Click [Browse] button to activate the file Selectr and Select the file. |
|
Form parameters | Optional | - | Specify the parameter of Form that becomes the request body.
Each parameter can be operated with the following.
|
|
Form parameters/ Name | Optional | Only environment variable is available | Enter the form name. | |
Mutlipart form parameters | Optional | - | Specify the multipart that becomes the request body.
Each part can be operated with the following.
|
|
Multipart form parameters/ Name | Optional | Only environment variable is available | Enter the name of a part on multipart. | |
Multipart form parameters/ Type | Optional | Not available | Select the type of part on multipart.
|
|
If type is file, grand Content-Length header to Part header | Optional | Not available | If [File] is set at [Multipart form parameters/ Type], select whether to give Content-Length header, with the size of file specified in input data as value, to part header.
|
|
Item name | Description | Remarks |
---|---|---|
Configure input schema from JSON file | Specify JSON file and set schema of input source. | Displayed if you select [JSON] in [Data type]. |
Item name | Required/Optional | Use of Variables | Description | Remarks |
---|---|---|---|---|
Data output source | Required | Not available | Select the output destination of response body.
|
|
Data type | Required | Not available | Select the data type of response body.
|
|
File path | Required | Available | Select or enter the file path which outputs the response body.
Click [Browse] button to activate the file Selectr and Select the file. |
|
Delete invalid XML characters | Optional | Not available | Select whether to delete invalid XML characters automatically if found any during analysis of JSON data.
|
|
Redirect automatically | Optional | Not available |
Select whether to redirect automatically if the redirecting destination is included in the response.
|
|
Errors occur when the status code of response is 4xx or 5xx | Optional | Not available |
Select whether to make the process an error if the status code of response is 4xx or 5xx.
|
Item name | Description | Remarks |
---|---|---|
Set schema specifying the JSON file | Specify JSON file and set the schema of the output destination. | Displayed if you select [JSON] in [Data type]. |
Item name | Required/Optional | Use of variables | Description | Remarks |
---|---|---|---|---|
Request headers | Optional | - | Specify HTTP header to include in the request.
Each request header can be operated with the following.
|
|
Request headers/ Name | Optional | Available | Enter the request header name. |
|
Request headers/ Value | Optional | Available | Enter the request header value. | |
Response headers | Optional | - | Specify the header name to retrieve from the HTTP header included in the response.
Each response header can be operated with the following.
|
|
Response headers/Name | Optional | Only environmental variables are available. | Enter the response header name. |
|
Item name | Required/Optional | Use of variables | Description | Remarks |
---|---|---|---|---|
Authentication | Required | Not available | Select how to authenticate when sending requests.
|
|
User name | Optional | Available | Enter the user name to use on the authentication. |
|
Password | Optional | Available | Enter the password to use on authentication. |
|
Item name | Required/Optional | Use of Variables | Description | Remarks |
---|---|---|---|---|
Mass data processing | Required | Not available | Select a data processing method.
|
Item name | Required/Optional | Use of variables | Description | Remarks |
---|---|---|---|---|
Comment | Optional | Not available | You can write a short description of this adapter. The description will be reflected in the specifications. |
<--In case the root is JSON object of object type --> <?xml version="1.0"?> <root type="object"> <JSON member name type="Attribute value showing JSON type">value</JSON member name> : </root> <-- In case the root is JSON object of array type --> <?xml version="1.0"?> <root type="array"> <element type="Attribute value showing JSON type">value</element> : </root> <-- In case the JSON member name is false as XML element name --> <?xml version="1.0"?> <root type="object"> <member type="Attribute value showing JSON type" name="JSON member name">value</member> : </root>
Element name | Attribute name | Description | Remarks | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
root | - | This is a root element that wraps JSON object. | ||||||||||||||
type | Specifies the attribute value that shows JSON type.
|
|
||||||||||||||
JSON member name | - | This is the element that shows JSON member. | ||||||||||||||
type | Sets the attribute value that shows JSON type.
|
|
||||||||||||||
element | - | Element showing the array element. | ||||||||||||||
type | Specifies the character string showing JSON type.
Specifies the same attribute value as the type attribute of JSON member name. |
|
||||||||||||||
member | - | This is the element alternatively specifying, in case the JSON member name is false as the element name. | ||||||||||||||
type | Outputs the character string that shows JSON type.
Specifies the same attribute value as JSON member name type attribute. |
|
||||||||||||||
name | Specifies the JSON member name.
Ex: XML data Specifying the JSON member name into the name attribute value specifying member element. <member type="string" name="1name">Suzuki</member>The XML data in the above example will be converted into the JSON member as follows. {"1name":"Suzuki"} |
|
<?xml version="1.0"?> <request> <body> <form> <form parameter name> <value>Form parameter value</value> </Form parameter name> : <-- in case form parameter name is false as the XML element name --> <parameter name="form parameter name"> <value>form parameter value</value> </parameter> : </form> </body> </request>
Element name | Attribute name | Description | Remarks |
---|---|---|---|
request | - | ||
body | - | ||
form | - | ||
form parameter name | - | Elements showing form parameter name. |
|
parameter | - | Elements when form parameter name is false as XML element name. |
|
name | Enter the form parameter name. |
|
|
value | - | Enter the form parameter value. |
|
<?xml version="1.0"?> <request> <body> <form> <firstname> <value>Ichiro</value> </firstname> <lastname> <value>Suzuki</value> </lastname> </form> </body> </request>Upon the above XML data, the form data stored in the request body will be as follows.
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> <-- If the type is "Character string". --> <part name> <value>form value</value> </part name> : <-- If the type is "File". --> <part name> <file> <path>file path</path> </file> </part name> : <-- If the part name is false as the XML element name. --> <part name="part name"> <value>part value</value> </part> : </multipart> </body> </request>
Element name | Attribute name | Description | Remarks |
---|---|---|---|
request | - | ||
body | - | ||
multipart | - | ||
part name | - | Element describing part name. |
|
part | - | Element when the part name is false as XML element name. |
|
name | Enter the part name. |
|
|
value | - | Enter the character string that becomes part body. |
|
file | - | ||
mimeType | Enter the MIME type that appears in the part Content-Type header. |
|
|
path | - | Enter the file path that becomes the part body. |
|
<?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>Upon the above XML data, the multipart form data stored in the request body will be as follows.
Content-Type: multipart/form-data; boundary=<boundary> --<boundary> Content-Disposition: form-data; name="firstname" Ichiro --<boundary> Content-Disposition: form-data; name="lastname" Suzuki --<boundary> Content-Disposition: form-data; name="attachment"; filename="profile.jpg" Content-Type: image/jpeg <data of /data/profile.jpg> --<boundary>--
<--In case the root is JSON object of object type. --> <?xml version="1.0"?> <root type="object"> <JSON member name type="attribute showing JSON type">value</JSON member name> : </root> <-- In case the root is the JSON object of array type --> <?xml version="1.0"?> <root type="array"> <element type="attribute showing JSON type">value</element> : </root> <-- In case the JSON member name is false as the XML element name --> <?xml version="1.0"?> <root type="object"> <member type="attribute name showing JSON type" name="JSON member name">value</member> : </root>
Element name | Attribute name | Description | Remarks | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
root | - | Element that wraps the JSON object. | ||||||||||||||
type | Attribute value showing JSON type will be set.
|
|||||||||||||||
JSON member name | - | Element showing JSON member. | ||||||||||||||
type | Attribute value showing JSON type will be set.
|
|||||||||||||||
element | - | Element name showing the array element. | ||||||||||||||
type | Character string showing JSON type will be output.
The same attribute value as the JSON member name type attribute will be set. |
|||||||||||||||
member | - | Element name used if the JSON member name is false as the XML element name. | ||||||||||||||
type | Character string showing JSON type will be output.
The same attribute value as JSON membe name type attribute will be set. |
|||||||||||||||
name | JSON member name will be output.
Ex: JSON member having the name that is false as the XML element name. {"1name":"Suzuki"}JSON object of the above example will be output with conversion into the following XML data. <member type="string" name="1name">Suzuki</member> |
<?xml version="1.0"?> <response> <body> <content>Data of response body</content> </body> </response>
Element name | Attribute name | Description | Remarks |
---|---|---|---|
response | - | ||
body | - | ||
content | - | This is the data of response body. |
Data differs depending on the value of Content-Type header of the response.
|
Component variable name | Description | Remarks |
---|---|---|
status_code | Stores HTTP status code of responses. |
|
reason_phrase | Stores the text phrase related to the HTTP status code of responses. |
|
error_response_body | Stores the response body in the case the response status code is "4xx" or "5xx". |
|
message_category | When errors occur, stores the message code category corresponding to the error. |
|
message_code | When errors occur, stores the codes of message code corresponding to the error. |
|
message_level | When errors occur, stores the message code severity corresponding to the error. |
|
error_type | When errors occur, stores the error type corresponding to the error. |
|
error_message | When errors occur, stores the error message. |
|
error_trace | When errors occur, stores the trace information of the error occurred. |
|
Exception name | Causes | Solution |
---|---|---|
ResourceNotFoundException Resource definition could not be found. Name:[] |
[Destination] is not specified. | Please specify [Destination] . |
ResourceNotFoundException Resource definition could not be found.Name: [<name of Global Resources>] |
Resource definition selected in [Destination] is not found. | Please check the global resource specified in [Destination] |
InvalidPropertyConfigurationException Required item of resource is not specified. :<Property name> |
[<Property name>] of [Destination] is not specified. | Please specify [<Property name>] in [Destination]. |
InvalidPropertyConfigurationException
<Property name> is not specified. |
[<Property name>] is not specified. | Specify [<Property name>]. |
FileIsDirectoryException | Path input in [File path] is directory. | Input file path in [File path]. |
PathIsNotAbsoluteException | Relative path is the path entered in [Path] or [File path]. | Enter the absolute path in [Path] or [File path]. |
PathIsRequiredException | While sending multipart form data, path that shows the data of file storing in a body part is not set in the input data. | Please check whether the path is set in the path element of the input data. |
RestServerException | Response with the status code "5xx" is returned from HTTP Server. | Please check the conditions of HTTP server and contents of request specified in [Destination] by referring to the contents of error messages. |
RestClientException | Response with the status code "4xx" is returned from HTTP Server. | Please check the entered path and the contents of request in [Path] by referring to the contents of error messages. |
org.apache.http.client.ClientProtocolException | Error occurred wile sending the request. | Please check the content of the error message. |
org.apache.http.conn.HttpHostConnectException | Could not connect to HTTP server or Proxy server. | Please check whether connection is available to the destined HTTP server or Proxy server or not. |
org.apache.http.conn.ConnectTimeoutException | Connection timeout occurred when connecting with HTTP server or Proxy server. | Please check the setting of [Connection timeout] in [Destination]. |
java.net.SocketTimeoutException | After connecting to HTTP server, timout occurred during the reply of sending the request and receiving the response. | Please check the setting of [Receive timeout] in [Destination]. |
javax.json.stream.JsonParsingException | Error occurred during processing the response body as JSON format. | Please check the setting and the response contents of [Response settings] referring to the error message. |
javax.json.stream.JsonGenerationException | Error occurred during the JSON conversion process of the input data. | Please check the input data contents. |