REST.delete: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 20: | Line 20: | ||
HTTP response as JSON (if full response) or server response, usually JSON but can be XML, HTML, or other formats. | HTTP response as JSON (if full response) or server response, usually JSON but can be XML, HTML, or other formats. | ||
'''Note:''' The delete request returns an empty string if the full response is not requested. | '''Note:''' The delete request returns an empty string for status 204 if the full response is not requested. | ||
|example= | |example= | ||
| Line 29: | Line 29: | ||
[r: response = REST.delete(baseURL + path, 1)] | [r: response = REST.delete(baseURL + path, 1)] | ||
</source> | </source> | ||
Returns: | Returns: | ||
Note the 204 - No Content status and thus no "body" element in the JSON. If the second parameter had been 0, an empty string would have been returned. | |||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
Full Response: { | Full Response: { | ||
Revision as of 04:15, 18 March 2019
REST.delete() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
Perform an HTTP delete request to the specified URL to delete the specified resource.
Usage
REST.delete(url, getFullResponse)
REST.delete(url, headers, getFullResponse)Parameters
url- String containing the URL to the resource or collection of resources.headers- JSON object containing header key:value pairs.getFullResponse- Boolean (0:1). True(1) to get full response.
Returns
HTTP response as JSON (if full response) or server response, usually JSON but can be XML, HTML, or other formats.
Note: The delete request returns an empty string for status 204 if the full response is not requested.
Example
Delete the indicated resource.
[h: baseURL = "https://reqres.in"]
[h: path = "/api/users/2"]
[r: response = REST.delete(baseURL + path, 1)]Returns: Note the 204 - No Content status and thus no "body" element in the JSON. If the second parameter had been 0, an empty string would have been returned.
Full Response: {
"status": 204,
"headers": {
"access-control-allow-origin": ["*"],
"cf-ray": ["4b928693e9805414-LAX"],
"date": ["Sun, 17 Mar 2019 22:50:25 GMT"],
"etag": ["W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\""],
"expect-ct": ["max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""],
"server": ["cloudflare"],
"set-cookie": ["__cfduid=dc5a1bd174f8f46cb9721f3a3338cff631552863025; expires=Mon, 16-Mar-20 22:50:25 GMT; path=/; domain=.reqres.in; HttpOnly"],
"x-powered-by": ["Express"]
}
}