doc-gen.http-request-action.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of igor-plugin-core Show documentation

Igor plugin providing common functionality.

There is a newer version: 0.6.8

# 'HTTP Request' Action

## Description
This action issues HTTP requests against web servers.

The action adds the results of the request to the data item under the 'webResponse' key.

A data item processed by this action could look like this: 
```
{
  "data": {},
  "meta": {
    "jobId": "69c52202-4bc6-4753-acfe-b24870a75e90",
    "simulation": true,
    "timestamp": 1601302794228
  },
  "webResponse": {
    "headers": {
      ":status": [
        "200"
      ],
      "access-control-allow-credentials": [
        "true"
      ],
      "access-control-allow-origin": [
        "*"
      ],
      "content-length": [
        "451"
      ],
      "content-type": [
        "application/json"
      ],
      "date": [
        "Mon, 28 Sep 2020 14:19:52 GMT"
      ],
      "server": [
        "gunicorn/19.9.0"
      ]
    },
    "body": {
      "args": {},
      "json": {
        "jobId": "69c52202-4bc6-4753-acfe-b24870a75e90"
      },
      "url": "https://httpbin.org/post"
    }
  }
}
```

## Parameters
The component can be configured by the following parameters:

Parameter | Description
:---|:---
Http Connector | An 'HTTP Connector' that is configured to execute the request.
Url | The HTTP(S) URL for the request.
Method | The HTTP method. Can be one of 'GET', 'HEAD', 'POST', 'PUT', 'DELETE', 'CONNECT', 'OPTIONS', 'TRACE' or 'PATCH'.
Headers | The HTTP headers to use for the request. Headers must be entered as 'key: value'-pairs, with each header in a separate line. Mustache templates are **not** supported in headers.
Body | The HTTP body to use for the request.
Ignore Errors | If checked, igor will ignore the HTTP result code and treat every response as HTTP 200 ('OK').
Simulation Safe | If checked, HTTP POST, PUT and DELETE will not be executed by the action during simulated job executions.
Username | A username for HTTP Basic Authentication. If set together with a password, a HTTP Authorization header with the encoded password will be added to every request.
Password | A password for HTTP Basic Authentication.
Target Key | The target key to put the web response in the data item.