EasyMorph Help

Category: Workflow / External

Sends a single HTTP request to a web server and receives a response. Intended for interactions with REST APIs, cloud applications and websites. Requires a configured Web Location connector.

Supports all HTTP methods - GET, POST, PUT, DELETE, HEAD, OPTIONS, CONNECT, TRACE, PATCH.

To simplify development and debugging, the action has a preview pane that shows the raw HTTP request that would be sent as well as a response preview.

The URL path is appended to the endpoint URL specified in Web Location connector. EasyMorph parameters can be inserted into the path using curly braces, if needed. Alternatively, the entire path can be specified with a parameter.

Examples:

URL parameters can be specified as name-value pairs. They will be encoded and appended as URL query. Value can be omitted, in needed. In this case, only the name will be appended to the URL query.

If a Web Location connector has permanent URL parameters specified they will be appended to all requests that are made using the connector. This can be used for scenarios where all requests should have an API key or secret specified.

The request body can be specified in one of the following ways:

This body type is suitable for sending simple JSONs. The JSON object is constructed from a list of name-value pairs. Both name and value can be specified with a parameter. If the value itself is a JSON object/array it's inserted verbatim thus allow object nesting.

When this body type is selected header "Content-Type:application/json" is set automatically.

Example:

Resulting request body (JSON):

{
  "Country":"CA",
  "Province":"ON",
  "Name":"EasyMorph",
  "Incorporated":2014,
  "Tags":["ETL", "analytics", "dataprep", "automation"]
}

This body type specifies body as a free-form text with parameters inserted, if needed.

This body type is equivalent to submitting a web-form. Name-value pairs are encoded as if it was a web-form.

Header Content-Type is automatically set to "application/x-www-form-urlencoded".

Example:

Resulting request body:

Country=CA&Province=ON&Name=EasyMorph&Incorporated=2014

The request body is read from the specified file and inserted verbatim.

Additional request headers can be specified. Header names and values can be specified either explicitly or using parameters.

Note that header Content-Length is calculated and added to every request automatically.

If a Web Location connector has permanent headers specified they will be added to all requests that are made using the connector. This can be used for scenarios where all requests should have an API key or secret.

There are 3 modes how a response would be processed in the Web Request action:

In this case, if the response status is not an error (i.e. HTTP status codes 4xx or 5xx) then the response will be ignored. This is basically "fire-and-forget" mode that is intended for submitting data and updates to remote endpoints.

In this mode, the response (error or not) is always received and transformed into a 1-row dataset in EasyMorph. The column names in such dataset correspond to response body, response status, and response headers (one column per each header).

In this case, if the response status is not an error (i.e. HTTP status codes 4xx or 5xx) then the response body (only body!) will be saved into the specified file verbatim.

Currently, there is no way to set HTTP cookies explicitly in the Web Request action. Under the hood, all cookies that come with responses are automatically stored in a cookie container that exists only during project execution. Cookies from the container are automatically appended to outgoing requests. In case of calls/iterations, the cookie container is passed to called/iterated modules or projects which in turn can add new cookies to it. This can be used for cookie-based web sessions.

When project execution is finished, the cookie container is discarded. No cookies are stored in project or Web Location connector.

* Iterate Web Request