# UrlEncode

| **Name**    | ***UrlEncode***                                                                    |
| ----------- | ---------------------------------------------------------------------------------- |
| Syntax      | UrlEncode (String str)                                                             |
| Purpose     | To return an escaped string.                                                       |
| Description | Returns a string by replacing invalid characters with valid ones for use in a URL. |
| Return Type | String                                                                             |
| Parameter   | str \[System.String] – The raw string to encode                                    |

![](https://github.com/astera-software/Astera_Data_Stack_v9/blob/main/.gitbook/assets/0%20\(2\)%20\(1\)%20\(1\)%20\(1\).png)

**Example**

In this example, we are passing the required parameters to the function transformation object using a *Variables* object.

Where,

*str =* <http://www.helloWorld.com/ABC-123/ABC123>

![](https://github.com/astera-software/Astera_Data_Stack_v9/blob/main/.gitbook/assets/1%20\(2\)%20\(1\)%20\(1\)%20\(1\).png)

Right-click on the function transformation object and select *Preview Output.* You can see that Astera has returned the escaped URL value.

![](https://github.com/astera-software/Astera_Data_Stack_v9/blob/main/.gitbook/assets/2%20\(2\)%20\(1\)%20\(1\)%20\(1\).png)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://documentation.astera.com/astera-data-stack-v7/functions/encoding/urlencode.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.