Enables scripted content fragments to make HTTP requests.
Methods
Delete
Performs an HTTP DELETE.
Velocity
#set($httpResponseResponse = $core_v2_http.Delete($url, "%{ BypassUrlFiltering = $bypassUrlFilteringArg, Headers = $headersArg, IsCacheable = $isCacheableArg, Query = $queryArg, TimeoutSeconds = $timeoutSecondsArg, VaryCacheByUser = $varyCacheByUserArg }"))
JavaScript
var httpResponseResponse = core_v2_http.Delete(url, { BypassUrlFiltering: bypassUrlFilteringArg, Headers: headersArg, IsCacheable: isCacheableArg, Query: queryArg, TimeoutSeconds: timeoutSecondsArg, VaryCacheByUser: varyCacheByUserArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
url | String | Url | Required | ||
options | Options | Set of optional parameters including: | Required | ||
BypassUrlFiltering | Boolean | When bypassed, request URLs will not be filtered based on content filtering rules. When not bypassed, only local network access limitations will be checked. | Optional | False | |
Headers | IDictionary | Dictionary of request header key/values. | Optional | ||
QueryString | QueryString of request header key/values. | ||||
IsCacheable | Boolean | Enables the response to be cached. | Optional | False | |
Query | IDictionary | Dictionary of URL query parameter key/values. | Optional | ||
QueryString | QueryString of URL query parameter key/values. | ||||
TimeoutSeconds | Int32 | Request timeout, in seconds. | Optional | 10 | |
VaryCacheByUser | Boolean | Identifies that cached responses should vary by accessing user. | Optional | True |
Returns
Get
Performs an HTTP GET.
Velocity
#set($httpResponseResponse = $core_v2_http.Get($url, "%{ BypassUrlFiltering = $bypassUrlFilteringArg, Headers = $headersArg, IsCacheable = $isCacheableArg, Query = $queryArg, TimeoutSeconds = $timeoutSecondsArg, VaryCacheByUser = $varyCacheByUserArg }"))
JavaScript
var httpResponseResponse = core_v2_http.Get(url, { BypassUrlFiltering: bypassUrlFilteringArg, Headers: headersArg, IsCacheable: isCacheableArg, Query: queryArg, TimeoutSeconds: timeoutSecondsArg, VaryCacheByUser: varyCacheByUserArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
url | String | Url | Required | ||
options | Options | Set of optional parameters including: | Required | ||
BypassUrlFiltering | Boolean | When bypassed, request URLs will not be filtered based on content filtering rules. When not bypassed, only local network access limitations will be checked. | Optional | False | |
Headers | IDictionary | Dictionary of request header key/values. | Optional | ||
QueryString | QueryString of request header key/values. | ||||
IsCacheable | Boolean | Enables the response to be cached. | Optional | False | |
Query | IDictionary | Dictionary of URL query parameter key/values. | Optional | ||
QueryString | QueryString of URL query parameter key/values. | ||||
TimeoutSeconds | Int32 | Request timeout, in seconds. | Optional | 10 | |
VaryCacheByUser | Boolean | Identifies that cached responses should vary by accessing user. | Optional | True |
Returns
Post
Performs an HTTP POST.
Velocity
#set($httpResponseResponse = $core_v2_http.Post($url, "%{ BypassUrlFiltering = $bypassUrlFilteringArg, Data = $dataArg, Headers = $headersArg, IsCacheable = $isCacheableArg, Query = $queryArg, TimeoutSeconds = $timeoutSecondsArg, VaryCacheByUser = $varyCacheByUserArg }"))
JavaScript
var httpResponseResponse = core_v2_http.Post(url, { BypassUrlFiltering: bypassUrlFilteringArg, Data: dataArg, Headers: headersArg, IsCacheable: isCacheableArg, Query: queryArg, TimeoutSeconds: timeoutSecondsArg, VaryCacheByUser: varyCacheByUserArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
url | String | Url | Required | ||
options | Options | Set of optional parameters including: | Required | ||
BypassUrlFiltering | Boolean | When bypassed, request URLs will not be filtered based on content filtering rules. When not bypassed, only local network access limitations will be checked. | Optional | False | |
Data | IDictionary | Dictionary of data to send as the body of the request. | Optional | ||
QueryString | QueryString of data to send as the body of the request. | ||||
String | Raw data to send as the body of the request. | ||||
Headers | IDictionary | Dictionary of request header key/values. | Optional | ||
QueryString | QueryString of request header key/values. | ||||
IsCacheable | Boolean | Enables the response to be cached. | Optional | False | |
Query | IDictionary | Dictionary of URL query parameter key/values. | Optional | ||
QueryString | QueryString of URL query parameter key/values. | ||||
TimeoutSeconds | Int32 | Request timeout, in seconds. | Optional | 10 | |
VaryCacheByUser | Boolean | Identifies that cached responses should vary by accessing user. | Optional | True |
Returns
Put
Performs an HTTP PUT.
Velocity
#set($httpResponseResponse = $core_v2_http.Put($url, "%{ BypassUrlFiltering = $bypassUrlFilteringArg, Data = $dataArg, Headers = $headersArg, IsCacheable = $isCacheableArg, Query = $queryArg, TimeoutSeconds = $timeoutSecondsArg, VaryCacheByUser = $varyCacheByUserArg }"))
JavaScript
var httpResponseResponse = core_v2_http.Put(url, { BypassUrlFiltering: bypassUrlFilteringArg, Data: dataArg, Headers: headersArg, IsCacheable: isCacheableArg, Query: queryArg, TimeoutSeconds: timeoutSecondsArg, VaryCacheByUser: varyCacheByUserArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
url | String | Url | Required | ||
options | Options | Set of optional parameters including: | Required | ||
BypassUrlFiltering | Boolean | When bypassed, request URLs will not be filtered based on content filtering rules. When not bypassed, only local network access limitations will be checked. | Optional | False | |
Data | IDictionary | Dictionary of data to send as the body of the request. | Optional | ||
QueryString | QueryString of data to send as the body of the request. | ||||
String | Raw data to send as the body of the request. | ||||
Headers | IDictionary | Dictionary of request header key/values. | Optional | ||
QueryString | QueryString of request header key/values. | ||||
IsCacheable | Boolean | Enables the response to be cached. | Optional | False | |
Query | IDictionary | Dictionary of URL query parameter key/values. | Optional | ||
QueryString | QueryString of URL query parameter key/values. | ||||
TimeoutSeconds | Int32 | Request timeout, in seconds. | Optional | 10 | |
VaryCacheByUser | Boolean | Identifies that cached responses should vary by accessing user. | Optional | True |