REST.delete: Difference between revisions
Jump to navigation
Jump to search
m (Stopped referencing the example in the Parameters for now, since the example is old.) |
m (Taustin moved page rEST.delete to REST.delete without leaving a redirect) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 8: | Line 8: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
REST.delete(url, payload, mediaType, getFullResponse) | REST.delete(url, payload, mediaType, getFullResponse) | ||
REST.delete(url, payload, mediaType, headers, getFullResponse) | REST.delete(url, payload, mediaType, headers, getFullResponse) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|url|String containing the URL to the resource or collection of resources.}} | {{param|url|String containing the URL to the resource or collection of resources.}} | ||
{{param|payload|JSON object containing the key:value pairs.}} | {{param|payload|JSON object containing the key:value pairs.}} | ||
{{param|mediaType|String containing a MIME type and charset. | {{param|mediaType|String containing a MIME type and charset. See example, but note that any character encoding other than {{code|UTF-8}} will be extremely difficult to produce in MapTool.}} | ||
{{param|headers|JSON object containing header key:value pairs.}} | {{param|headers|JSON object containing header key:value pairs.}} | ||
{{param|getFullResponse|Boolean (0:1). True(1) to get full response.}} | {{param|getFullResponse|Boolean (0:1). True(1) to get full response.}} | ||
| Line 25: | Line 25: | ||
|example= | |example= | ||
Delete the indicated resource | Delete the indicated resource: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: | [h: baseurl = "https://reqres.in"] | ||
[h: path = "/api/users/ | [h: path = "/api/users"] | ||
[h: mediaType = "application/json; charset=utf-8"] | |||
[ | [h: getFullResponse = 1] | ||
</ | |||
[h: payload = '{ "name": "smith", "job": "agent" }'] | |||
[h: response = REST.delete(baseurl + path, payload, mediaType, getFullResponse)] | |||
<br> | |||
<pre> | |||
[r: json.indent(response, 2)] | |||
</pre> | |||
</syntaxhighlight> | |||
Returns: | Returns: | ||
Note the 204 - No Content status and thus no "body" element in the JSON. If the | Note the 204 - No Content status and thus no "body" element in the JSON. If the <code>getFullResponse</code> parameter had been 0, an empty string would have been returned. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
Full Response: { | Full Response: { | ||
"status": 204, | "status": 204, | ||
"headers": { | "headers": { | ||
"access-control-allow-origin": ["*"], | "access-control-allow-origin": ["*"], | ||
"cf-ray": [" | "cf-cache-status": ["DYNAMIC"], | ||
"date": ["Sun, | "cf-ray": ["533501e1ee362a47-SEA"], | ||
"date": ["Sun, 10 Nov 2019 03:40:51 GMT"], | |||
"etag": ["W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\""], | "etag": ["W/\"2-vyGp6PvFo4RvsFtPoIWeCReyIC8\""], | ||
"expect-ct": ["max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""], | "expect-ct": ["max-age=604800, report-uri=\"https://report-uri.cloudflare.com/cdn-cgi/beacon/expect-ct\""], | ||
"server": ["cloudflare"], | "server": ["cloudflare"], | ||
"set-cookie": ["__cfduid= | "set-cookie": ["__cfduid=d6d2ff57f7c34e64294da00c51c3b9e3b1573357250; expires=Mon, 09-Nov-20 03:40:50 GMT; path=/; domain=.reqres.in; HttpOnly; Secure"], | ||
"via": ["1.1 vegur"], | |||
"x-powered-by": ["Express"] | "x-powered-by": ["Express"] | ||
} | } | ||
} | } | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Latest revision as of 23:59, 10 May 2023
REST.delete() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
• Last checked for compatibility with version 1.5.7
Perform an HTTP delete request to the specified URL to delete the specified resource.
Usage
REST.delete(url, payload, mediaType, getFullResponse)
REST.delete(url, payload, mediaType, headers, getFullResponse)Parameters
url- String containing the URL to the resource or collection of resources.payload- JSON object containing the key:value pairs.mediaType- String containing a MIME type and charset. See example, but note that any character encoding other thanUTF-8will be extremely difficult to produce in MapTool.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"]
[h: mediaType = "application/json; charset=utf-8"]
[h: getFullResponse = 1]
[h: payload = '{ "name": "smith", "job": "agent" }']
[h: response = REST.delete(baseurl + path, payload, mediaType, getFullResponse)]
<br>
<pre>
[r: json.indent(response, 2)]
</pre>Returns:
Note the 204 - No Content status and thus no "body" element in the JSON. If the getFullResponse parameter had been 0, an empty string would have been returned.
Full Response: {
"status": 204,
"headers": {
"access-control-allow-origin": ["*"],
"cf-cache-status": ["DYNAMIC"],
"cf-ray": ["533501e1ee362a47-SEA"],
"date": ["Sun, 10 Nov 2019 03:40:51 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=d6d2ff57f7c34e64294da00c51c3b9e3b1573357250; expires=Mon, 09-Nov-20 03:40:50 GMT; path=/; domain=.reqres.in; HttpOnly; Secure"],
"via": ["1.1 vegur"],
"x-powered-by": ["Express"]
}
}See Also
Version Changes
- 1.5.7 - Altered parameters to line up with other REST functions.