urlDecode

Description

Returns the decoded version of a URL-encoded string.

URL encoding replaces certain characters with escape sequences (for example, spaces become %20) so they can be safely transmitted in URLs. Use urlDecode to restore the original values after parsing.

Syntax

Like many functions in DataPrime, urlDecode supports two notations, function and method notation. These interchangeable forms allow flexibility in how you structure expressions.

urlDecode(string: string): string

(string: string).urlDecode(): string

Arguments

Example

Use case: Decode query string parameters

Suppose you want to parse query string parameters and decode any encoded values. Consider this document:

{
  "domain": "https://www.coralogix.com",
  "path": "/home",
  "query_string": "name=Tom%20Kosman&b=c&c=d"
}

First, extract the parameters into an object using kv:

extract query_string into query_string_parameters using kv(pair_delimiter='&', key_delimiter='=')

This produces:

{
  "domain": "https://www.coralogix.com",
  "path": "/home",
  "query_string": "name=Tom%20Kosman&b=c&c=d",
  "query_string_parameters": {
    "name": "Tom%20Kosman",
    "b": "c",
    "c": "d"
  }
}

Now decode the name field:

replace query_string_parameters.name with urlDecode(query_string_parameters.name)

replace query_string_parameters.name with query_string_parameters.name.urlDecode()

Output

{
  "domain": "https://www.coralogix.com",
  "path": "/home",
  "query_string": "name=Tom%20Kosman&b=c&c=d",
  "query_string_parameters": {
    "name": "Tom Kosman",
    "b": "c",
    "c": "d"
  }
}