Official |[REST] Execute DELETE

Operation name

Execute DELETE

Function overview

Executes HTTP DELETE method request.

Data model

The data model of this component is XML type.

= Remarks =

For more details on output schema, refer to Schemas.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter a name that is used on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Path	Optional	Available	Specify a relative path from the URL entered in URL of Destination.	It will be URL encoded using the encoding entered or selected in Encoding.
Encoding	Optional	Available	Select or enter an encoding used for URL encoding. When you enter encoding, specify one of the encodings supported in Java SE Runtime Environment 8. = Remarks = For details, refer to "Supported Encodings" (http://docs.oracle.com/javase/8/docs/technotes/guides/intl/encoding.doc.html).	The default value is "UTF-8". If omitted, "UTF-8" will be set.
Query parameter	Optional	-	Specify names and values for query parameters to be concatenated to the URL. Each query parameter can be operated with the following buttons: Up Move the selected query parameter upwards by one row. Down Move the selected query parameter downwards by one row. Add Add a query parameter. Delete Delete the query parameter.	It will be URL encoded using the encoding entered or selected in Encoding.
Query parameter/Name	Optional	Available	Enter the name of query parameter.	When omitted, the query parameter won't be concatenated to the URL.
Query parameter/Value	Optional	Available	Enter the value of query parameter.

Response settings

Item name	Required/Optional	Use of variables	Description	Remarks
Output destination	Required	Not available	Select output destination of a response body. Data (Default) Output it to the result data. Output it in the format selected in Data format. File Output it to the file specified in File path.
Data format	Required	Not available	Select a data format of response body. XML (Default) Process as XML format. JSON Process as JSON format. Other Process as text or binary format.	Displayed when Data is selected in Output destination. The output schema varies depending on the selected data format. For more details on output schema, refer to Output schema.
File path	Required	Available	Select or enter a file path of output destination of a response body. The Browse button launches a file chooser that allows you to select a file.	Displayed when File is selected in Output destination. Note Specify an absolute path of HULFT Square Storage for the file path. With the exception of the path separator "/", the Restricted characters of HULFT Square Storage can't be used.
Remove invalid XML characters	Optional	Not available	Select whether or not to remove invalid characters for XML automatically if they're found while parsing JSON format data. Selected Invalid characters for XML will be removed. Not selected (Default) Invalid characters for XML won't be removed.	Displayed when JSON is selected in Data format.
Redirect automatically	Optional	Not available	Select whether or not to make the processing an error when the response status code is "4xx" or "5xx". Selected Processing will end as an error. Not selected (Default) Processing won't end as an error.	For more details on redirection, refer to Auto redirection.
Error when response status code is 4xx or 5xx	Optional	Not available	Select whether or not to make the processing an error when the response status code is "4xx" or "5xx". Selected Processing will end as an error. Not selected (Default) Processing won't end as an error.

Property actions

Item name	Description	Remarks
Set output schema with JSON file	Specify a JSON file and set the output schema.	Displayed when JSON is selected in Data format.

Header settings

Item name	Required/Optional	Use of variables	Description	Remarks
Request header	Optional	-	Specify HTTP headers to be included in a request. Each request header can be operated with the following buttons: Up Move the selected request header upwards by one row. Down Move the selected request header downwards by one row. Add Add a request header. Delete Delete the request header.
Request header/Name	Optional	Available	Enter the request header name.	When omitted, the request header isn't included in request.
Request header/Value	Optional	Available	Enter the request header value.
Response header	Optional	-	Specify header names to get from HTTP headers included in a response. Each response header can be operated with the following buttons: Up Move the selected response header upwards by one row. Down Move the selected response header downwards by one row. Add Add a response header. Delete Delete the response header.	A response header is defined as a component variable with the name entered in Name.
Response header/Name	Optional	Only environment variables are available	Enter the response header name.	Case-insensitive. When omitted, it's not defined as a component variable. When there's a space/tab/line feed before or after the name, it will be trimmed and defined as a component variable.

Authentication settings

Item name	Required/Optional	Use of variables	Description	Remarks
Authentication	Required	Not available	Select an authentication method on sending a request. None (Default) Authentication won't be performed. Basic authentication Basic authentication will be performed. Digest authentication Digest authentication will be performed. NTLM authentication NTLM authentication will be performed. Using Auth Connections Authentication will be performed using connection resources.
User	Optional	Available	Enter the user name used for authentication.	This field is displayed when Basic authentication, Digest authentication, or NTLM authentication is selected in Authentication.
Password	Optional	Available	Enter the password used for authentication.	This field is displayed when Basic authentication, Digest authentication, or NTLM authentication is selected in Authentication.
Connection Setting	Optional	Not available	Select a connection resource to use for authentication.	This field is displayed when Using Auth Connections is selected in Authentication.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Optional	Not available	Select a data processing method. Apply script settings (Default) The setting for mass data processing in the script properties is applied to the connector. Do not perform mass data processing Mass data processing isn't performed. Perform mass data processing Mass data processing is performed.

Item name

Required/Optional

Use of variables

Description

Remarks

Data processing method

Optional

Not available

Select a data processing method.

Apply script settings

(Default)

The setting for mass data processing in the script properties is applied to the connector.

Do not perform mass data processing

Mass data processing isn't performed.

Perform mass data processing

Mass data processing is performed.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this connector.

Schemas

Input schema

None.

Output schema

The schema varies depending on Data format settings of Response settings.

In the case of XML

The schema varies depending on the XML data of the response body.

In the case of JSON

When the response body is JSON type data, the data is converted to XML and output to the result data.

The schema converted from JSON to XML is as follows:

<-- When the root attribute indicates object-type JSON -->
<?xml version="1.0"?>
<root type="object">
  <JSON member name type="attribute value that represents JSON type">value</JSON member name>
    :
</root>

<-- When the root attribute indicates array-type JSON -->
<?xml version="1.0"?>
<root type="array">
  <element type="attribute value that represents JSON type">value</element>
    :
</root>

<-- When the JSON member name is invalid for XML element name -->
<?xml version="1.0"?>
<root type="object">
  <member type="attribute value that represents JSON type" name="JSON member name">value</member>
    :
</root>

Element name

Attribute name

Description

Remarks

root

-

Root element wrapping JSON object.

type

Attribute value that represents JSON type is set.

Attribute value

Description

object

Represents JSON object type.

Example: JSON object consisting of object type

{"name":"Suzuki"}

The above JSON object is converted to XML data as follows and output:

<root type="object">
  <name type="string">Suzuki</name>
</root>

array

Represents JSON array type.

Example: JSON object consisting of array type

["apple","grape","orange"]

The above JSON object is converted to XML data as follows and output:

<root type="array">
  <element type="string">apple</element>
  <element type="string">grape</element>
  <element type="string">orange</element>
</root>

JSON member name

-

Element that represents JSON member.

type

Attribute value that represents JSON type is set.

Attribute value	Description
string	Represents JSON string type. Example: A JSON member with string type value {"name":"Suzuki"} The above JSON member is converted to the following XML data and output: <name type="string">Suzuki</name>
number	Represents JSON numeric type. Example: A JSON member with numeric type value {"age":37} The above JSON member is converted to the following XML data and output: <age type="number">37</age>
boolean	Represents JSON boolean type. Example: A JSON member with boolean type value {"success":true} The above JSON member is converted to the following XML data and output: <success type="boolean">true</success>
object	Represents JSON object type. Example: A JSON member with object type value {"name":{"first":"Ichiro","last":Suzuki"}} The above JSON member is converted to the following XML data and output: <name type="object"> <first type="string">Ichiro</first> <last type="string">Suzuki</last> </name>
array	Represents JSON array type. A JSON array type element is shown in "element" element. When a JSON array type element is object type, XML data with the schema that represents the JSON object is output to the child element of "element" element. When the type is other than that, the value is output to the "element" element. The schema is as follows: <JSON member name type="array"> <element type="attribute value that represents JSON type">value</element> : </JSON member name> Example: A JSON member with array type value {"fruits":["apple","grape","orange"]} The above JSON member is converted to the following XML data and output: <fruits type="array"> <element type="string">apple</element> <element type="string">grape</element> <element type="string">orange</element> </fruits>
null	Represents JSON null type. Example: A JSON member with null type value {"name":null} The above JSON member is converted to the following XML data and output: <name type="null"/>

element

-

Element name that represents array element.

type

A string that represents JSON type is output.

The same attribute value as the type attribute of the JSON member name is set.

member

-

Element name used when the JSON member name is invalid for XML element name.

type

A string that represents JSON type is output.

The same attribute value as the type attribute of the JSON member name is set.

name

A JSON member name is output.

Example: A JSON member with an invalid name for XML element name.

{"1name":"Suzuki"}

The above JSON member is converted to the following XML data and output:

<member type="string" name="1name">Suzuki</member>

In the case of Other

<?xml version="1.0"?>
<response>
  <body>
    <content>response body data</content>
  </body>
</response>

Element name	Attribute name	Description	Remarks
response	-
body	-
content	-	Data of the response body.	The data varies depending on the value of Content-Type header of the response. When any of the following conditions are satisfied, the response body is considered as text data and the string output is encoded with the charset parameter value in the Content-Type header. The type of the Content-Type header is "text". The subtype of the Content-Type header ends with "xml" or "json". When none of the above conditions is satisfied, the response body is considered as binary data. From that, byte array data will be generated based on the charset parameter value of the Content-Type header, then it will be converted into Base64 format, and output as string. When there's no Content-Type header or charset parameter, "ISO-8859-1" is used by default.

Element name

Attribute name

Description

Remarks

response

-

body

-

content

-

Data of the response body.

The data varies depending on the value of Content-Type header of the response.

When any of the following conditions are satisfied, the response body is considered as text data and the string output is encoded with the charset parameter value in the Content-Type header.
- The type of the Content-Type header is "text".
- The subtype of the Content-Type header ends with "xml" or "json".
When none of the above conditions is satisfied, the response body is considered as binary data. From that, byte array data will be generated based on the charset parameter value of the Content-Type header, then it will be converted into Base64 format, and output as string.
When there's no Content-Type header or charset parameter, "ISO-8859-1" is used by default.

Loading schema in Mapper

The method to load schema varies depending on Data format of Response settings.

In the case of XML

The schema needs to be loaded manually.

Specify the schema of the response body.

In the case of JSON

When using Set output schema with JSON file, the schema is loaded automatically.

In the case of Other

The schema is loaded automatically.

= Remarks =

You can edit the automatically loaded schema.

For details, refer to Edit Schema.

Mass data processing

Mass data processing is supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available component variables

Component variable name	Description	Remarks
status_code	HTTP status code of the response is stored.	The default value is null.
reason_phrase	Text phrase related to the HTTP status code of the response is stored.	The default value is null.
error_response_body	The response body with a response status code "4xx" or "5xx" is stored.	The default value is null.
message_category	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity of the message code corresponding to the error is stored.	The default value is null.
error_type	When an error occurs, the error type is stored.	The default value is null. The format of the error type is as follows. Example: java.io.FileNotFoundException
error_message	When an error occurs, the error message is stored.	The default value is null.
error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Auto redirection

When Redirect automatically is selected, the behavior will be as follows.

When the status code of response is any of the following, the request will be resent to the URI indicated in the "Location" header in the response. When upper case is included in the host name of the redirection destination, it's converted to lower case for redirection.

301: (Moved Permanently)
302: (Found)
303: (See Other)
307: (Temporary Redirect)

The result data when the response status code is 400 or higher

When the response status code is 400 or higher, the response body is output to the result data.

At that time, the schema of result data varies depending on the value of Content-Type header of the response.

When the subtype of the Content-Type header ends with "xml"

The schema varies depending on the XML data of the response body.
When the subtype of the Content-Type header ends with "json"

As described in "In the case of JSON".
When other than any of the above

As described in "In the case of Other".
= Remarks =
To content element, the response body encoded according to the following rules is output.
- When there's a Content-Type header in the response header, the response body is encoded with the charset parameter value of the Content-Type header.
- When there's no Content-Type header in the response header, or no charset parameter in the Content-Type header, the response body is encoded with "ISO-8859-1".

Message codes, exception messages, and limitations

Connector	Message code	Exception message	Limitations
Messages and limitations of the REST connector