Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

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 permissions restrictions


Panel
titleSyntax
Info

This function accepts keyword arguments.

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

  • Parameters

String url - The URL to send the request to.

String contentType -  The MIME type used in the HTTP 'Content-type' header. [optional]

Integer connectTimeout - The timeout for connecting to the URL in milliseconds. Default is 10,000. [optional]

Integer readTimeout - The read timeout for the operation in milliseconds. Default is 60,000. [optional]

String username - If specified, the call will attempt to authenticate with basic HTTP authentication. [optional]

String password - The password used for basic HTTP authentication, if the username parameter is also present. [optional]

Dictionary[String, String] headerValues -  A dictionary of name/value pairs that will be set in the HTTP header. [optional]

Boolean bypassCertValidation -  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. [optional]

  • Returns

String - The content returned for the DELETE operation. 

  • Scope

Gateway, Vision Client, Perspective Session

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

system net httpDelete, net.httpDelete