httpDelete

Availability

This routine is available starting with SIL Engine™ 4.1.0.

Syntax

httpDelete(url, request)

Starting with SIL Engine™ 4.5.0:

httpDelete(url, request [, proxy])

Description

Executes an HTTP DELETE for a given URL using the specified HttpRequest object. The needed parameters can either be included in the initial url or they can be created using the httpCreateParameter routine and added to the HttpRequest parameter.

Requests can also be sent through a proxy.

Parameters

Parameter name

Type

Required

Description

url

string

Yes

The URL.

requestHttpRequestYesAn HttpRequest object containing headers, cookies, parameters.
proxyHttpProxyNoAn HttpProxy object containing the host and port of the proxy server.

The "request" parameter should have the HttpRequest type described here. The HttpProxy type is described here.

Return type

variable return type - depending on the left hand side operator type

Example

The following example calls an HTTP DELETE using the JIRA REST API that results in deleting the user with the "guest1" username from the "jira-guests" group.

string baseUrl = getJIRABaseUrl();
string requestUrl = baseUrl + "/rest/api/2/group/user";

HttpRequest request;
HttpHeader authHeader = httpBasicAuthHeader("admin", "admin");
request.headers += authHeader;
request.parameters += httpCreateParameter("groupname", "jira-guests");
request.parameters += httpCreateParameter("username", "guest1");

httpDelete(requestUrl, request);

See also