Availability
This routine is available starting with katl-commons 4.1.0.
Syntax
httpDelete(url, request)
Description
Executes an HTTP DELETE for the 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.Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
url | string | Yes | The URL. |
| request | HttpRequest | Yes | A HttpRequest object containing headers, cookies, parameters. |
The request parameter should have the type HttpRequest 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