Connection to REST Web Service

image_pdfimage_print

This connection allows, in a generic way, data retrieval from web services that apply to the REST (representational state transfer) architectural style. Such “RESTful APIs” are widely used by a variety of service providers.

The REST connection supports REST web services that

  • are based on HTTP
  • use the HTTP methods GET or POST (e.g. DELETE or PUT are out of scope)
  • return data either in JSON or XML format
Main Settings

Resource:

 

HTTP Method:

GET, POST

Header Parameters:

The header parameters of the webservice as parameter-value pairs

URL Parameters: The URL parameters of the webservice as parameter-value pairs
Advanced Settings

Authentication Method:

  • None
  • Basic: basic authentication for REST requests.
    Parameters: User and Password
  • NTL:
  • OAuth2 Client Credentials: the Open authorization Standard OAuth2 with client credentials used as Authorization Grant.
    Parameters: Key, Secret, Scope
  • OAuth2 Password Credentials: the Open authorization Standard OAuth2 with password credentials used as Authorization Grant. Parameters:  Client ID, User name, Password, Scope

Request Body:

As an alternative to simple body parameters, the complete HTTP body can be specified.

SSL Mode:

verify, trust, off

Timeout:

The timeout of the webservice request in seconds.

Note: one specific group of supported web services are those that fulfill the OData (Open Data) Protocol. For more information, see http://www.odata.org/.

image_pdfimage_print