| Info |
|---|
|
This routine is available starting with SIL Engine™ 4.1.0. |
| Button handy |
|---|
| blank | true |
|---|
| color | #0052CC |
|---|
| name | Send Feedback |
|---|
| link | https://docs.google.com/forms/d/e/1FAIpQLScmToBe3vynAlb5fdKwCGxYqnTbDc66sIBgeecG2BuFDuHc7g/viewform?entry.2002826954=httpDelete+-+15488903 |
|---|
| width | auto |
|---|
|
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| heading | 0 |
|---|
| columnTypes | s,s,s,s |
|---|
| multiple | false |
|---|
| columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
|---|
| enableSorting | false |
|---|
|
Syntax | httpDelete(url, request [[, proxy] [, deleteDataObject]]) |
|
...
Starting with SIL Engine™ 4.5.0:
...
| Package | http | Alias | | Pkg Usage | delete(url, request [[, proxy] [, deleteDataObject]]) |
|
Description
| Excerpt |
|---|
|
Executes an HTTP DELETE for a given URL using the specified HttpRequest object. |
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
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| columnTypes | s,s,s,s |
|---|
| heading | 0 |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
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. |
|
...
The "request" parameter should have the HttpRequest type described here. The HttpProxy type is described here.
Return type
...
| deleteDataObject | variable: primitive type, array or struct | No | Normally, http delete requests do not need a body. However, we were signaled that some APIs do require some data inside the body, so we adapted to this situation by adding this optional parameter. It contains the data to be added to the body. |
|
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 username from the "jira-guests" group.
| Code Block |
|---|
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); |
| Note |
|---|
The request parameter should have the HttpRequest type described here. The HttpProxy type is described here. |
See also
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 25 |
|---|
| showSpace | false |
|---|
| cql | label = "http_ |
|---|
|
...
| routine" and space = currentSpace ( ) | | labels |
|---|
|
...
...