getUrl (Deprecated)
Table of Contents
Note:
- It is recommended to use invoke URL, since this task will be deprecated.
- Each getUrl task execution triggers an API call in the back-end. These API calls are deducted from your overall external calls limit that is provided for your Creator plan. Here, the system counts the number of actual executions, and not the number of times the task appears in the script.
Overview
The get url deluge task corresponds to a HTTP GET request. It is normally supported by services to perform a read operation like fetching data.
Note: Using this task, you can download files of size up to 5 MB.
Return Type
- Text
- Key-value
Syntax
<variable> = getUrl( <stringUrl>, <headerMap>, <boolean> );
| Parameter | Data type | Description |
|---|---|---|
| <variable> | TEXT or KEY-VALUE | Variable which will contain the returned response. |
| <stringUrl> | TEXT | The URL which will return the response. |
<headerMap> (optional) | KEY-VALUE | Variable holding header values as key-value pairs. |
<boolean> (optional) | BOOLEAN | Value 'true' will return a simple response content as text. Value 'false' will return the response code (HTTP status code), and response content as key-value. |
Examples
The following snippet returns the response of the given url:
xmlResp = getUrl("https://www.w3schools.com/xml/cd_catalog.xml");
Response Format
The success response when the third param is set to false will be returned in the following format:
{
"responseText":,
"responseHeader": {
"date": "Fri, 31 Jul 2020 02:47:31 GMT",
"last-modified": "Tue, 14 Feb 2017 13:51:43 GMT",
"server": "ECS (sec/975F)",
"vary": "Accept-Encoding",
"x-frame-options": "SAMEORIGIN",
"x-powered-by": "ASP.NET",
"content-type": "text/xml",
"etag": "\"84e9d179c986d21:0\"",
"x-cache": "HIT",
"accept-ranges": "bytes",
"cache-control": "public,max-age=14400,public",
"age": "8812"
},
"responseCode": 200
}
"responseText":
"responseHeader": {
"date": "Fri, 31 Jul 2020 02:47:31 GMT",
"last-modified": "Tue, 14 Feb 2017 13:51:43 GMT",
"server": "ECS (sec/975F)",
"vary": "Accept-Encoding",
"x-frame-options": "SAMEORIGIN",
"x-powered-by": "ASP.NET",
"content-type": "text/xml",
"etag": "\"84e9d179c986d21:0\"",
"x-cache": "HIT",
"accept-ranges": "bytes",
"cache-control": "public,max-age=14400,public",
"age": "8812"
},
"responseCode": 200
}