Categories

Versions

GET (REST) (Web Mining)

Synopsis

Sends a GET http request to a REST service as is used in CRUD operations to download data.

Description

This operator can send GET requests to REST services. It can deal with returning JSON as a document, as well as returning binary data as a file.

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.

DELETE (REST)

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

PATCH (REST)

Sends a PATCH request to a REST service. This is mostly used to update parts of an existing 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.

Output

  • response (IOObject)

    The output port. Depending on whether json or binary mode is set in the response body, this returns a document or a file.

Parameters

  • request_urlThe REST service URL which the operator should call. Range:
  • response_body_typeWhether the result of the REST service is JSON or binary data. This parameter determines the result type of this operator (document or file). 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

Read a JSON response

This process reads a JSON response from a REST service and returns it as a document.