HTTP

HTTP request valves.

Requires module HttpClient to be configured and deployed.

Valves are NOT part of the Item iteration API. To create Items from response use ItemCreateValve.

Common configuration

These configuration properties applies to all HTTP valves.

Properties

Name	Description	Default value	Mandatory	Expanded
url	Request URL.	N/A
destination	HttpClient instance to use.	"default"
headers	JSON map of request headers.	{}
parameters	JSON map of request parameters. Only applicable if "content_type" is "application/x-www-form-urlencoded"	{}
content	The body as a JSON object. Only applicable if "content_type" is "application/json"	{}
accept_404	If set to true the valve will NOT fail with a status code of 404.	false

Example

{
  "name" : "<valve-name>",
  "config" : {
    "url" : "http://127.0.0.1:8080/echo",
    "destination" : "default",
    "headers": {
      "Accept": "application/json"
    },
    "parameters": {
      "id": "xxx"
    }
  }
}

Response

If request is successful (status 200) the response body and headers are set in the current flow state. If request fails, Pipe will fail with response text as reason.

Name	Description
headers	JSON map of response headers
body	If response body is of type application/json the data will be parsed as JSON. If it is of type text/* the data will be parsed as text. Otherwise it will be binary.
response_code	HTTP response code as an integer.