httpDelete
Syntax | httpDelete(url, request [, proxy]) | Package | http |
Alias |
| Pkg Usage | delete(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 function 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. |
request | HttpRequest | Yes | An HttpRequest object containing headers, cookies, parameters. |
proxy | HttpProxy | No | An HttpProxy object containing the host and port of the proxy server. |
Return Type
String
Variable return type depends 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 = ();
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
Need support? Create a request with our support team.
Copyright © 2005 - 2026 Appfire | All rights reserved.