# tRESTRequest Receives GET/POST/PUT/PATCH/DELETE requests from the clients on the server end. tRESTRequest accepts the HTTP and/or HTTPS requests from the clients and supports GET, POST, PUT, PATCH and DELETE HTTP methods. Information noteNote: To enable the HTTPS support, you have to generate a keystore and add some HTTPS security configuration properties in the *org.ops4j.pax.web.cfg* file of your Runtime container before deploying the service on it. For more information, see [HTTP configuration](https://help.qlik.com/talend/r/en-US/8.0/esb-container-administration-guide/http-configuration). ## tRESTRequest Standard properties These properties are used to configure tRESTRequest running in the Standard Job framework. The Standard tRESTRequest component belongs to the ESB family. *This component is relevant only when used with one of the Talend solutions with ESB, as it should be used with the Service Repository node and the Data Service creation related wizard(s).* ## Basic settings | Properties | Description | | --- | --- | | API Definition / Definition | Click [...] to browse to the API definition file to
initialize your component endpoint, API mappings and documentation from your
API definition.

The output flow values in the API mapping are used in generated Java code,
therefore they need to be camel case compliant. Output flow values are taken or
computed from the API definition with these priorities:

| | REST
Endpoint | Fill this field with the service path where the REST service is accessible. For Data Service deployments in Talend Runtime Container (ESB Runtime), do not include hostname:port in this field.

The default endpoint value for a new component is "/restservice/v1". This value is meant as an example. Replace it with your own path value. You can define the endpoint path using context variables. | | REST API
Mapping | Click the [+] button beneath the
mapping table to add lines to specify HTTP request:


Output
Flow: Click the [...] button to specify the name of an
output flow and set the schema for that output flow in the dialog box
afterwards.

The schema is not
mandatory, so if you do not need to pass additional parameters to the
tRESTRequest
component, you can leave the schema empty. However, you will have to
populate the schema if you have URI Path parameters set in the
URI Pattern
field or if you need to add optional request parameters such as URI
Query, HTTP Header or Form parameters, to the URI specified in the
REST Endpoint
field.

Add a schema with the name
*body* to get the request body
of POST and PUT methods. It supports Document, String, and Byte types.

If you specify URI parameters in the output flow schema, you
might need to define what type of parameter it is in the Comment field of the
schema. By default, if you leave the Comment field empty, the parameter is
considered as a Path parameter. Below is a list of supported Comment values:



Information noteNote: We recommend you to set the
default values of your optional parameters (Header, Query, Form). To
do so, fill in the Default columns of the schema.


HTTP Verb: Select a HTTP method
(GET/POST/PUT/PATCH/DELETE/OPTIONS/HEAD) from the list.


URI pattern: Fill this field with
REST-ful URIs that describe the resource.


Consumes: Select the format type of the
consume content that the component will use from XML
or JSON, XML, JSON, Form, Multipart and
Any in the list when the HTTP method
is POST, PUT, or PATCH.


Produces: When the HTTP
method is GET, POST, PUT, PATCH, or DELETE, select the format type of
the produce content that the component will use from XML or JSON, XML, JSON, HTML and Any, or select
<oneway> in the list to accept one way
requests.


Streaming: Select this
check box to stream the response data by chunks so that the large
volumes of data can be processed efficiently. | | Security | Select this check box to enable the security option for the
current service. Select the security scheme from:

| | JWT configuration | JWT configuration options appear when JWT Bearer Token
is selected in the Security list. In the
Keystore Type list, select:



For the Java Keystore (\*.jks) or PKCS12
Keystore (\*.p12, \*.pfx) keystore type, you need to enter the
location of the keystore file and the associated password in the
Keystore File and Keystore
Password fields respectively. You can also set the
Keystore Alias and Audience as
needed.

For the JSON Web Key Sets (JWKS) keystore type, you need
to specify the URL of the online key sets in the JWKS
URL field. You can also set the Audience
as needed. | | Use Service Locator | Select this check box to enable the Service Locator. It maintains the availability of the service to help meet demands and service
level agreements (SLAs). Specify the Service namespace and the Service name in the
corresponding fields. | | Use Service
Activity Monitor | Select this check box to enable the Service Activity
Monitor. It captures events and stores this information to facilitate
in-depth analysis of service activity and track-and-trace of messages
throughout a business transaction. This can be used to analyze service
response times, identify traffic patterns, perform root cause analysis and
more. | | Use
Authorization | Select this check box to enable authorized call. This option
appears when SAML Token is selected in
the Security list.

For more information about the management of user roles and
rights, see [Managing ESB Resources and
authorizations](https://help.qlik.com/talend/r/en-US/8.0/administration-center-user-guide/managing-esb-resources-and-authorizations) and [Talend Identity and Access
Management](https://help.qlik.com/talend/r/en-US/8.0/esb-infra-services-configuration-guide/talend-identity-and-access-management). | | Use Business
Correlation | Select this check
box to enable the correlation option so that chained service calls will
be grouped under the same correlation ID. tRESTRequest will extract the
correlation ID from the request header and store it in the component
variable for further use in the flow.

If this option is not enabled on the client side, a
correlation ID will be generated automatically in tRESTRequest. | ## Advanced settings | Properties | Description | | --- | --- | | Log
messages | Select this check box to log the message exchange
between the service provider and the consumer. | | Expose OpenAPI documentation | Select this checkbox to activate documentation of an API implementation.
When this option is enabled, deployed REST service offers the following endpoints
to access API documentation:



If this option is enabled and the REST service is built as a Microservice,
you can activate or deactivated API documentation by adding the
exposeOpenApi=[true/false] parameter in the
application.properties configuration file inside the
Microservice JAR, or using the -DexposeOpenApi=[true/false]
parameter in the command when running the Microservice.

Information noteNote:

This option is available only if you have installed the R2025-10 Talend Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

To use this feature in Talend Runtime, you need to install Talend Runtime 8.0.1-R2025-10 patch or a later one and execute command
feature:install cxf-rs-description-openapi-v3 inside
the Runtime console. For more information, see [Starting Talend Runtime with
console](https://help.qlik.com/talend/en-US/esb-container-administration-guide/8.0/starting-talend-runtime-with-console) and [Feature Scope](https://help.qlik.com/talend/en-US/esb-container-administration-guide/8.0/feature-scope). | | Wrap JSON
Request | Select this check box to wrap the JSON request with a
*root* element. | | Attributes to Elements | Select this check box to exclude @ in the response
attribute. | | Convert
JSON values to String in response | Select this check box to convert the JSON values to
string format in the response. | | JAXRS properties | This option appears when JWT Bearer Token is selected
in the Security list in the Basic
settings tab. Click [+] to add as many
properties as needed to the table. In the Property Name
field, you can either select the property from the drop-down list, or enter a
property name that is not available in the list. Enter the value of the property
in the Property Value field. For more information on the
JAXRS properties, see the [Apache CXF documentation](https://cxf.apache.org/docs/jax-rs-jose.html#JAXRSJOSE-Configuration). | | Service Locator Customer Properties | This option appears when Use Service Locator
is enabled in the Basic
settings tab. Click [+] to
add as many properties as needed to the table. Enter the name and the value of
each property in the Property Name field
and the Property Value field respectively
to identify the service. | | Service
Activity Customer Properties | This option appears when Use Service Activity Monitor is enabled in
the Basic settings
tab. Click [+] to
add as many properties as needed to the table. Enter the name and the value
of each property in the Property
Name field and the Property Value field respectively to
identify the service. | | tStatCatcher
Statistics | Select this check
box to gather the Job processing metadata at a Job level as well as at
each component level. | ## Global Variables | Variables | Description | | --- | --- | | Global
Variables | NB\_LINE:
the number of rows processed. This is an After variable and it returns an integer.


URI: the URI of the REST request. This is a Flow variable and it
returns a string.


URI\_BASE: the base URI of the REST request. This is a
Flow variable and it returns a string.


URI\_ABSOLUTE: the absolute URI of the
REST request. This is a Flow variable and it returns a string.


HTTP\_METHOD: the
http method. This is a Flow variable and it returns a string.


ATTACHMENT\_HEADERS: the attachment headers from the REST request. This
is a Flow variable and it returns a list of attachment header values.


ATTACHMENT\_FILENAMES: the attachment filenames from the REST request.
This is a Flow variable and it returns all attachment filenames.


PRINCIPAL\_NAME:
the principal name of the REST request. This is a Flow variable and it returns a
string.


CORRELATION\_ID:
the correlation ID by which chained service calls will be grouped. This is a Flow
variable and it returns a string.


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 checkbox is
cleared, if the component has this checkbox.

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 more information about variables, see [Using contexts and variables](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/contexts-and-variables). | ## Usage | Usage guidance | Description | | --- | --- | | **Usage
rule** | This component covers the possibility that a Talend Job can be wrapped as a service, with the ability to input
a request to a service into a Job and return the Job result as a service
response.

The tRESTRequest component should be used
with the tRESTResponse component to provide a Job result as a
response, in case of a request-response communication style. | | Limitation | Using context variables for dynamic endpoint or Service Locator namespace works in Talend Studio only. It is not supported in Talend Runtime. | **Related concepts** * [Using a REST service to accept HTTP POST requests and send responses](https://help.qlik.com/talend/en-US/components/8.0/esb-rest/trestrequest-trestclient-tlogrow-using-rest-service-to-accept-http-post-requests-and-send-responses-standard-component-esb-this) * [Using a REST service to accept HTTP POST requests in an HTML form](https://help.qlik.com/talend/en-US/components/8.0/esb-rest/trestrequest-trestresponse-txmlmap-tjavarow-using-rest-service-to-accept-http-post-requests-in-html-form-standard-component-esb-this) * [Using a REST service to accept HTTP POST requests](https://help.qlik.com/talend/en-US/components/8.0/esb-rest/use-rest-accept-http-post) * [Using a REST service to accept HTTP GET requests and send responses](https://help.qlik.com/talend/en-US/components/8.0/esb-rest/trestrequest-trestresponse-txmlmap-trestresponse-txmlmap-using-rest-service-to-accept-http-get-requests-and-send-responses-standard-component-esb-this) * [Using URI Query parameters to explore the data of a database](https://help.qlik.com/talend/en-US/components/8.0/esb-rest/trestrequest-trestresponse-tfixedflowinput-tmysqloutput-using-uri-query-parameters-to-explore-data-of-database-standard-component-esb-this)