URL

Decode a URL-encoded component, such as the value of a query parameter.  This function decodes all URL-encoded characters and outputs the decoded text.  For more details on URL encoding see this Wikipedia article.

For example, this input: Sherlock%20Holmes%3A%20Detective
Would decode to: Sherlock Holmes: Detective

This function is the inverse of Encode Component. Note that in many cases, it may be easier to use Decode Component followed by Decode Query if you are starting with a complete URL.  

Input Fields

• text: the URL-encoded text

Output Fields

• output: the decoded text

Decode a URL-encoded query string into a query object. A query string is everything after the ? in a URL. Certain special characters, like space, :, ?, /, etc., need to be encoded because they have special meaning in the URL itself. For more details see this Wikipedia article.

For example, in this URL: https://www.example.com/searchcustomers?name=John%20Doe&region=North%20America the query string is the part starting with “name”, and this function would convert it to this object:

{
  "name": "John Doe",
  "region": "North America"
}

Once in this object form, it is much easier to extract particular query parameters using Get or Get Multiple.

This function is the inverse of Encode Query.  

Input Fields

• query (text): the query string

Output Fields

• output (object): the query object

Encode text into a URL-encoded text for use within a URL.  This function encodes all reserved characters, like space : ? / etc., for use in a URL. For more details on URL encoding, see this Wikipedia article.

For example, if you want to build a URL where the value of name comes from a previous step, then you can use this function to encode that value as follows:

If your input is: Sherlock Holmes: Detective
Then the encoded output is: Sherlock%20Holmes%3A%20Detective

You can use Concatenate to then build the URL, by adding the output above to https://www.example.com/searchcustomers?name= to get https://www.example.com/searchcustomers?name=Sherlock%20Holmes%3A%20Detective.

This function is the inverse of Decode Query.  Note that in many cases, it may be easier to use Encode Query because it will build a full URL query with multiple query parameters including the encoding.  

Input Fields

• text: the text to encode

Output Fields

• output: the URL-encoded output

Encode a query object into a URL-encoded query object.  A query string is everything after the ? in a URL.  Certain special characters, like space : ? / etc., need to be encoded because they have special meaning in the URL itself.  For more details see this Wikipedia article.

For example, in this URL:

https://www.example.com/searchcustomers?name=John%20Doe&region=North%20America

the query string is the part starting with “name”, and you could create it by using Encode Query with this input

{
    "name": "John Doe",
    "region": "North America"
}

which would encode to this query string:

name=John%20Doe&region=North%20America

The usage pattern is:  build a query object using Object functions such as Construct, Set, or Zip - this makes it easy to build an object using dynamics inputs from previous steps.  Then encode it to a string using this function - or you may choose to use the query object directly with Raw Request.

This method is the inverse of Decode Query.  

Input Fields

• data (object): the query object

Output Fields

• output (text): the query string

Overview

A convenience function that makes it easy to construct a URL string from it’s component parts.

Input Fields

• protocol: the URL protocol field:  http, https, etc
• host: the host name
• port: the port number (typically:  80 for http, 443 for https)
• path: the resource path within the host
• query: the query string (optional) without the ?

Output Fields

• url: the formatted URL string

Parse a URL string into its components, with proper encoding

Input Fields

• url (required text): the url to parse

Output Fields

• protocol (text): the URL’s protocol returned in lower case (e.g. http:)
• host (text): the URL’s host property returned in lower case (e.g. www.test.com)
• port (number): the port specified in the URL returned as a number; if no port is specified, a null value is returned
• path (text): the entire path of the URL; this is everything following the host (including the port) and before the query portion of the URL
• query (text): the entire query string portion of the URL

Example

For the input url: http://www.test.com:8080/test url?value=example&value2=URL

You’d get the following outputs:

• protocol: http:
• host: www.test.com
• port: 8080
• path: /test%20url
• query: value=example&value2=URL