REST Client

Description

REST Client is a step in the Lookup Plugin for Process Studio Workflows. The REST Client workflow step enables you to consume RESTful services.

Configurations

No.	Field Name	Description
	General Tab: Enter basic connection information for accessing a resource.
1	Step name	Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
2	URL	Specify the path to a REST client resource. (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).
3	Accept URL from field	Enable checkbox to accept path to a resource from a field.
4	URL field name	Choose a field which defines the path to a resource
5	HTTP method	Choose how the step interacts with a resource---options are either GET, PUT, DELETE, POST, HEAD, or OPTIONS
6	Get Method from field	Enable checkbox to GET method from a field.
7	Method fieldname	Specify the field from which the GET method is defined.
8	Body field	Choose a field from the dropdown list that contains the request body for POST, PUT,and DELETE methods
9	Application type	Choose 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
10	Result fieldname	Specify the name of the result output field
11	HTTP status code fieldname	Specify the name of the HTTP status code field
12	Response time (milliseconds) fieldname	Specify the name of the response time field
	Authentication Tab:	Enter authentication details for a resource in the Authentication tab.
1	HTTP Login	Specify the username required to access a resource
2	HTTP Password	Specify the password associated with the provided HTTP Login user name
3	Preemptive	Enable checkbox to send the authentication credentials before a server gives an unauthorized response
4	Proxy Host	Specify the name of a proxy host, if proxy authentication is required
5	Proxy Port	Specify the port number of a proxy host, if proxy authentication is required
	SSL Tab: Provide authentication details for accessing a resource that requires SSL certificate
authentication
1	Truststore file	Specify the location of a truststore file
2	Truststore password	Specify the password associated with the provided truststore file
	Headers Tab:
1	Field	Define the content of any HTTP headers using an existing field. Populate the list of fields by clicking the Get fields button.
2	Name	Provide a name
	Parameters Tab:
1	Parameter	Choose the parameters to set value.
2	Parameter	Provide parameter values for POST, PUT, and DELETE requests. GET parameters should be part of the URL directly.
	Matrix Parameters Tab:
1	Parameter	Choose the parameter to set value.
2	Parameter	Provide parameter values for POST, PUT, and DELETE requests. GET parameters should be part of the URL directly.