Rest Client

PLEASE NOTE: This documentation applies to an earlier version. For the most recent documentation, visit the Pentaho Enterprise Edition documentation site.

Description

The REST Client transformation step enables you to consume RESTfull services. Representational State Transfer (REST) is a key design idiom that embraces a stateless client-server architecture in which the web services are viewed as resources and can be identified by their URLs.

Note: The data of the input fields can be escaped by the Calculator step and the function "Mask XML content from string A" or "Escape HTML content"

General Tab

The General tab is where you enter basic connection information for accessing a resource.

Option	Definition
Step name	Name of this step as it appears in the transformation workspace
URL	Indicates the path to a resource
Accept URL from field	Designates the path to a resource is defined from a field
URL field name	Indicates the field from which the path to a resource is defined
HTTP method	Indicates how the step interacts with a resource---options are either GET, PUT, DELETE, POST, HEAD, or OPTIONS
Get Method from field	Designates the GET method is defined from a field
Method fieldname	Indicates the field from which the GET method is defined
Body field	Contains the request body for POST, PUT, and DELETE methods
Application type	Designates what type of application a resource is---options are either TEXT PLAIN, XML, JSON, OCTET STREAM, XHTML, FORM URLENCODED, ATOM XML, SVG XML, or TEXT XML
Result fieldname	Designates the name of the result output field
HTTP status code fieldname	Designates the name of the HTTP status code field
Response time (milliseconds) fieldname	Designates the name of the response time field

Authentication Tab

If necessary, enter authentication details for a resource in the Authentication tab.

Option	Definition
HTTP Login	Indicates the username required to access a resource
HTTP Password	Indicates the password associated with the provided HTTP Login user name
Preemptive	Option to send the authentication credentials before a server gives an unauthorized response
Proxy Host	Indicates the name of a proxy host, if proxy authentication is required
Proxy Port	Indicates the port number of a proxy host, if proxy authentication is required

SSL Tab

The SSL tab is where you provide authentication details for accessing a resource that requires SSL certificate authentication.

Option	Definition
Truststore file	Indicates the location of a truststore file
Truststore password	Indicates the password associated with the provided truststore file

Headers Tab

The Headers tab enables you to define the content of any HTTP headers using an existing field. Populate the list of fields by clicking the Get fields button.

Parameters Tab

The Parameters tab enables you to define parameter values for POST, PUT, and DELETE requests. GET parameters should be part of the URL directly.