Categories

Versions

PATCH (REST) (Web Mining)

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 JSON as a document.

For submitting data, you can either submit a document input, or manually entered JSON 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

DELETE (REST)

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

GET (REST)

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

POST (REST)

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

PUT (REST)

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 (IOObject)

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

Output

  • response (IOObject)

    The output port returning a document.

Parameters

  • request_urlThe REST service URL which the operator should call. Range:
  • request_body_typeWhether the request body to the REST service should be JSON or form data. This parameter determines the expected input data of this operator (document or file) and available parameters. Range:
  • request_jsonOnly 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. Range:
  • request_formOnly 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. Range:
  • json_content-typeOnly 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! Range:
  • binary_content-typeOnly 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! Range:
  • request_headersAdditional headers to include in the request. Can be for example used to log into protected services via an "Authorization" header. Range:
  • fail_on_endpoint_errorBy 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. Range:

Tutorial Processes

PATCH JSON to a REST service with input document

This process patches JSON (coming from a document) to a REST service and returns the response from it as a document.

PATCH JSON to a REST service with macro

This process patches JSON (coming from the request json parameter) to a REST service and returns the response from it as a document. The JSON parameter contains two macros which are replaced before the request is sent.