| //// |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| http://www.apache.org/licenses/LICENSE-2.0 |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| //// |
| :documentationPath: /plugins/transforms/ |
| :language: en_US |
| :page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/transforms/http/src/main/doc/http.adoc |
| = HTTP client |
| |
| == Description |
| |
| The HTTP client transform performs a simple call to a base URL with options appended as shown below: |
| |
| ==== |
| http://<URL>?param1=value1&param2=value2&param3.. |
| ==== |
| |
| The result is stored in a String field with the specified name. |
| |
| == Options |
| |
| [width="90%", options="header"] |
| |=== |
| |Option|Description |
| |Transform name|Name of the transform; this name has to be unique in a single pipeline |
| |URL|The base URL string |
| |Accept URL from field?|Enable this option if you want to get the URL from a previous transform. |
| Enabling this will also allow you to specify the name of the input field. |
| |URL field name|The name of the incoming field that contains the URL |
| |Connection timeout| |
| |Socket timeout|The number of seconds to wait if no data is returned from the server. |
| |Connection close wait time |
| |Result fieldname|The name of the field to store results |
| |HTTP status code field name|The name of the field to store the HTTP response code (e.g. 200, 404) |
| |Response time (milliseconds) field name|The name of the field to store the response time |
| |Http Login|The username to be passed during HTTP (Basic) authentication |
| |HTTP Password|The password to be passed during HTTP (Basic) authentication |
| |Proxy Host|The hostname of the Proxy Server to be used |
| |Proxy Port|The port number of the Proxy Server to be used |
| |Parameters|Area where you define the parameter name-value pairs to pass on the URL |
| |Custom HTTP Headers|Area where you define optional HTTP headers |
| |=== |
| |
| == FAQ |
| === The HTTP client transform doesn't do anything |
| |
| *Q*: The HTTP client transform doesn't do anything, how do I make it work? |
| |
| *A*: The HTTP client transform needs to be triggered. Use a Row generator transform generating e.g. 1 empty row and link that with a hop to the HTTP client transform. |
| |
| === The HTTP client transform and SOAP |
| |
| *Q*: Does the HTTP client support SOAP? |
| |
| *A*: No, it just calls an URL with arguments. Future transforms may provide SOAP functionality, Work is underway on a WebService transform supporting WSDL. |