On this page



Corresponds to HTTP method DELETE.


For an HTTP Service, you must have rules set up for the action.

The httpService.delete() takes the following parameter:

Parameter Type Description
args document

A document of the following form:

    "url": <mixed>,
    "headers": <array>

The fields of args are as follows:

Argument Type Description
url string or document The URL string for the HTTP request. Alternatively, you can specify the components of the URL. See Alternative URL Arguments.
headers array of strings Optional. Corresponds to the HTTP header fields and the corresponding values are an array of values (e.g. "Content-Type": [ "application/json" ]) for the request.

A JSON document representing the HTTP response with the following form:

   "status": <string>,
   "statusCode": <integer>,
   "contentLength": <integer>,
   "headers": <array>,
   "cookies": <array>,
   "body": <binary>

Each field of the response is described as follows:

Field Type Description
status string A string representing the HTTP status.
statusCode integer The HTTP status code.
contentLength integer The length of the content returned in body.
headers array of documents Contains document for each HTTP header in the response.
cookies document Optional. Cookie name and value pairs.
body binary Optional. The raw body of the HTTP response.

Alternative URL Arguments

As an alternative to passing the url argument as a single string, you can instead specify the individual components of the url string.


The following HTTP action arguments and the url argument are mutually exclusive. Use one or the other, but not both.

If you use the following arguments instead of the url argument, the scheme and host fields are required.

Name Contents
scheme Required. Defaults to https. Permissible values are https and http.
host Required. The hostname for the request. In the URL, the hostname is
path The path portion of the URL. In, the path portion is /api/v1.0/entity.

Document containing keys and values which map to the URL’s query string. Each key must be a string and each value must be an array of strings, even if the array contains only one element. For example, given the query document:

{ "x": ["hello"], "y": ["world"] }

The query is appended to the outgoing request as ?x=hello&y=world.

If an array contains more than one element, all the elements are included with the same key. For example, given the query document:

{ "cars": ["Porsche", "Audi"], "bikes": ["Trek", "Marin"] }

The query is appended to the outgoing request as ?cars=Porsche&cars=Audi&bikes=Trek&bikes=Marin.

fragment The portion of the URL which comes after the anchor (#).
username In conjunction with the password argument, allows the action to access the given URL with basic authentication.
password See username.