Skip to main content

PATCH (REST)

Synopsis​

Sends a PATCH http request to a REST service as is used in CRUD operations to update parts of existing data at a specific URI.

Description​

This operator can send PATCH requests to REST services. It will return text (e.g. JSON or XML) as a document.

For submitting data, you can either submit a document input, or manually entered JSON or XML via parameter. In either case, macros within the input will be resolved before it is submitted to the REST service.

By default, if a web service returns an error in the 4xx or 5xx range, this operator will fail. Sometimes however, some requests may be expected to fail, but the process should still continue (and for example return the error in the output document). In those cases, deselect the fail_on_endpoint_error parameter to keep the process going.

Differentiation​

Sends a DELETE request to a REST service. This is mostly used to delete a resource.

​

Sends a GET request to a REST service. This is mostly used to download a resource.

​

Sends a POST request to a REST service. This is mostly used to create a new resource.

​

Sends a PUT request to a REST service. This is mostly used to replace an existing resource or put a resource at a specific location.

Input​

request​

The optional input port expecting a document. This port does not need an input as long as the request json or request xml parameter is set.

Output​

response​

The output port returning a document.

Parameters​

Request url​

The REST service URL which the operator should call.

Request body type​

Whether the request body to the REST service should be JSON, XML or form data. This parameter determines the expected input data of this operator (document or file) and available parameters.

Request json​

Only visible if json is selected as the request body type AND no input document is passed to the operator. The JSON contained here is then send as the request body to the REST service.

Request xml​

Only visible if xml is selected as the request body type AND no input document is passed to the operator. The XML contained here is then send as the request body to the REST service.

Request form​

Only visible if form is selected as the request body type. The entries contained here are then send as a form request to the REST service.

Json content-type​

Only visible if json is selected as the request body type. The Content-Type sent with the JSON request. Be careful, setting this to a value not expected by the REST endpoint may very well cause the endpoint to not work correctly or even reject the request!

Xml content-type​

Only visible if xml is selected as the request body type. The Content-Type sent with the XML request. Be careful, setting this to a value not expected by the REST endpoint may very well cause the endpoint to not work correctly or even reject the request!

Binary content-type​

Only visible if binary is selected as the request body type. The Content-Type sent with the binary request. Be careful, setting this to a value not expected by the REST endpoint may very well cause the endpoint to not work correctly or even reject the request!

Request headers​

Additional headers to include in the request. Can be for example used to log into protected services via an "Authorization" header.

Inject connection secret​

Enables the injection of a connection secret by replacing the identifier and secret placeholders defined in the selected connection entry with their respective values.

Connection entry​

This parameter is only available when inject connection secret is enabled. This parameter is used to specify a repository location that represents a connection entry.

Fail on endpoint error​

By default, if a web service returns an error in the 4xx or 5xx range, this operator will fail. Sometimes however, some requests may be expected to fail, but the process should still continue (and for example return the error in the output document). In those cases, select this checkbox to keep the process going. Note that this operator will still fail if the call fails for technical reasons, e.g. the URL cannot be reached.