system.net.httpDelete

This function is used in Python Scripting.

Description

Performs an HTTP DELETE to the given URL.

Keep in mind that JRE proxy settings will influence how these functions conduct their network activities.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

tip

This function accepts keyword arguments.

system.net.httpDelete(url, [contentType], [connectTimeout], [readTimeout], [username], [password], [headerValues], [bypassCertValidation])

Parameters

Type	Parameter	Description
String	url	The URL to send the request to.
String	contentType	[Optional] The MIME type used in the HTTP 'Content-type' header.
Int	connectTimeout	[Optional] The timeout for connecting to the URL in milliseconds. Default is 10,000
Int	readTimeout	[Optional] The read timeout for the operation in milliseconds. Default is 60,000.
String	username	[Optional] If specified, the call will attempt to authenticate with basic HTTP authentication.
String	password	[Optional] The password used for basic HTTP authentication, if the username parameter is also present.
PyDictionary	headerValues	[Optional] A dictionary of name/value pairs that will be set in the HTTP header.
Boolean	bypassCertValidation	[Optional] If the target address in an HTTPS address, and this parameter is TRUE, the system will bypass all SSL certificate validation. This is not recommended, though is sometimes necessary for self-signed certificates.

Returns

String - The content returned for the DELETE operation.

Scope

Gateway, Vision Client, Perspective Session

Code Example

Code Snippet

# This example attempts to perform a DELETE operation
URL = "http://myURL/folder.resource"
system.net.httpDelete(URL)