tREST Standard properties - 6.5

REST

author
Talend Documentation Team
EnrichVersion
6.5
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance > Third-party systems > Internet components (Integration) > REST components
Data Quality and Preparation > Third-party systems > Internet components (Integration) > REST components
Design and Development > Third-party systems > Internet components (Integration) > REST components
EnrichPlatform
Talend Studio

These properties are used to configure tREST running in the Standard Job framework.

The Standard tREST component belongs to the Internet family.

The component in this framework is available in all Talend products.

Basic settings

Warning:

To build Jobs that need to be deployed into the Talend Runtime, it is recommended to use the tRESTClient component which is best suited for the Talend Runtime.

For more information about the tRESTClient component, see tRESTClient.

Schema and Edit Schema

A schema is a row description, it defines the number of fields that will be processed and passed on to the next component.

This component always uses a built-in, read-only schema that contains two columns:

- Body: stores the result from the server end.

- ERROR_CODE: stores the HTTP status code from the server end when an error occurs during the invocation process. The specific meanings of the errors codes are subject to definitions of your Web service provider. For reference information, visit en.wikipedia.org/wiki/List_of_HTTP_status_codes.

Click Edit Schema to view the schema structure.

Warning:

Changing the schema type may result in loss of the schema structure and therefore failure of the component.

URL

Type in the URL address of the REST Web server to be invoked.

HTTP Method

From this list, select an HTTP method that describes the desired action. The specific meanings of the HTTP methods are subject to definitions of your Web service provider. Listed below are the generally accepted HTTP method definitions:

- GET: retrieves data from the server end based on the given parameters.

- POST: creates and uploads data based on the given parameters.

- PUT: updates data based on the given parameters, or if the data does not exist, creates it.

- DELETE: removes data based on the given parameters.

HTTP Headers

Type in the name-value pair(s) for HTTP headers to define the parameters of the requested HTTP operation.

For the specific definitions of HTTP headers, consult your REST Web service provider. For reference information, visit en.wikipedia.org/wiki/List_of_HTTP_headers.

HTTP Body

Type in the payload to be uploaded to the server end when the POST or PUT action is selected.

Advanced settings

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

Global Variables

Global Variables

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.

Usage

Usage rule

Use this component as a REST Web service client to communicate with a REST Web service provider. It must be linked to an output component.

Limitation

JRE 1.6 must be running for this component to work properly.