core_v2_http Script API

Ben Tiedt — Wed, 20 Nov 2019 14:54:08 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:54:08

Enables scripted content fragments to make HTTP requests.

Delete
Get
Post
Put

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
url	`String`	Url	Required
BypassUrlFiltering	`Boolean`	When bypassed, request URLs will not be filtered based on content filtering rules.	Optional	False
Headers	`IDictionary`	Dictionary of request header key/values.	Optional
Headers	`[[QueryString Script API Type\|QueryString]]`	QueryString of request header key/values.	Optional
IsCacheable	`Boolean`	Enables the response to be cached.	Optional	False
Query	`IDictionary`	Dictionary of URL query parameter key/values.	Optional
Query	`[[QueryString Script API Type\|QueryString]]`	QueryString of URL query parameter key/values.	Optional
TimeoutSeconds	`Int32`	Request timeout, in seconds.	Optional	10
VaryCacheByUser	`Boolean`	Identifies that cached responses should vary by accessing user.	Optional	True

Returns

[[HttpResponse Script API Type|HttpResponse]]

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
url	`String`	Url	Required
BypassUrlFiltering	`Boolean`	When bypassed, request URLs will not be filtered based on content filtering rules.	Optional	False
Headers	`IDictionary`	Dictionary of request header key/values.	Optional
Headers	`[[QueryString Script API Type\|QueryString]]`	QueryString of request header key/values.	Optional
IsCacheable	`Boolean`	Enables the response to be cached.	Optional	False
Query	`IDictionary`	Dictionary of URL query parameter key/values.	Optional
Query	`[[QueryString Script API Type\|QueryString]]`	QueryString of URL query parameter key/values.	Optional
TimeoutSeconds	`Int32`	Request timeout, in seconds.	Optional	10
VaryCacheByUser	`Boolean`	Identifies that cached responses should vary by accessing user.	Optional	True

Returns

[[HttpResponse Script API Type|HttpResponse]]

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
url	`String`	Url	Required
BypassUrlFiltering	`Boolean`	When bypassed, request URLs will not be filtered based on content filtering rules.	Optional	False
Data	`IDictionary`	Dictionary of data to send as the body of the request.	Optional
	`[[QueryString Script API Type\|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
Headers	`[[QueryString Script API Type\|QueryString]]`	QueryString of request header key/values.	Optional
IsCacheable	`Boolean`	Enables the response to be cached.	Optional	False
Query	`IDictionary`	Dictionary of URL query parameter key/values.	Optional
Query	`[[QueryString Script API Type\|QueryString]]`	QueryString of URL query parameter key/values.	Optional
TimeoutSeconds	`Int32`	Request timeout, in seconds.	Optional	10
VaryCacheByUser	`Boolean`	Identifies that cached responses should vary by accessing user.	Optional	True

Returns

[[HttpResponse Script API Type|HttpResponse]]

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
url	`String`	Url	Required
BypassUrlFiltering	`Boolean`	When bypassed, request URLs will not be filtered based on content filtering rules.	Optional	False
Data	`IDictionary`	Dictionary of data to send as the body of the request.	Optional
	`[[QueryString Script API Type\|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
Headers	`[[QueryString Script API Type\|QueryString]]`	QueryString of request header key/values.	Optional
IsCacheable	`Boolean`	Enables the response to be cached.	Optional	False
Query	`IDictionary`	Dictionary of URL query parameter key/values.	Optional
Query	`[[QueryString Script API Type\|QueryString]]`	QueryString of URL query parameter key/values.	Optional
TimeoutSeconds	`Int32`	Request timeout, in seconds.	Optional	10
VaryCacheByUser	`Boolean`	Identifies that cached responses should vary by accessing user.	Optional	True

Returns

[[HttpResponse Script API Type|HttpResponse]]