General tab

General tab in REST client

Use the General tab to enter the following connection information for your REST client resource:

Option

Description

URL

Specify the path to the REST client resource. To specify the path from a field within the incoming PDI stream, select Accept URL from field.

Accept URL from field

Select to designate the path to the resource that is defined by a field within the incoming PDI stream. If you select this option, URL field name becomes available.

URL field name

Select the field from the incoming PDI stream. The field should contain the path to the resource. This option is available only if you select Accept URL from field.

HTTP method

Select how this step interacts with the resource. You can select from the following possible actions:- GET: To retrieve a resource.

  • POST: To create a new resource.

  • PUT: To create or update an existing resource.

  • DELETE: To delete a resource.

  • HEAD: To retrieve only the header information to a resource.

  • OPTIONS: To describe other methods and operations supported by the server.

  • PATCH: To make partial updates on a resource.

Get Method from field

Select to designate the GET method that is defined from a field within the incoming PDI stream. If you select this option, Method fieldname becomes available.

Method fieldname

Select the field that defines the GET method. This option is available only if you select Get Method from field.

Body field

Select the field to contain the request body for POST, PUT, and PATCH methods.Note: If using a request that was written prior to Pentaho 8.3, you can no longer use the DELETE method to carry a payload from the Body field. Instead, you must modify the request and pass the payload using one of the following methods:

  • Use the PUT method to pass the data in the Body field and then send a DELETE request.

  • Use the DELETE method, but pass all data to the server directly as part of the URL.

Application type

Select the application type of the resource content.

Result fieldname

Specify the name of the resulting output field.

HTTP status code fieldname

Specify the name of the HTTP status code field.

Response time (milliseconds) fieldname

Specify the name of the response time field.

Response header field name

Specify the name of the response header field.

Last updated

Was this helpful?