REST.put: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=REST.put |trusted=true |version=1.5 |description= Perform an HTTP put request to the specified URL to update an existing resource. |usage= <source lang=...") |
|||
| (9 intermediate revisions by 4 users not shown) | |||
| Line 2: | Line 2: | ||
|name=REST.put | |name=REST.put | ||
|trusted=true | |trusted=true | ||
|version=1.5 | |version=1.5.0 | ||
|description= | |description= | ||
Perform an HTTP put request to the specified URL to update an existing resource. | Perform an HTTP put request to the specified URL to update an existing resource. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
REST.put(url, payload, mediaType, getFullResponse) | REST.put(url, payload, mediaType, getFullResponse) | ||
REST.put(url, payload, mediaType, headers, getFullResponse) | REST.put(url, payload, mediaType, headers, getFullResponse) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|url|}} | {{param|url|String containing the URL to the resource or collection of resources.}} | ||
{{param|payload|}} | {{param|payload|JSON object containing the key:value pairs.}} | ||
{{param|mediaType|}} | {{param|mediaType|String containing a MIME type and charset. See example.}} | ||
{{param|headers|}} | {{param|headers|JSON object containing header key:value pairs.}} | ||
{{param|getFullResponse|Boolean (0:1) to get full response.}} | {{param|getFullResponse|Boolean (0:1). Use true(1) to get full response.}} | ||
'''Returns''' | '''Returns''' | ||
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. | ||
|example= | |example= | ||
Update a user with a put request. | Update a user with a put request. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: baseURL = "https://reqres.in"] | [h: baseURL = "https://reqres.in"] | ||
[h: path = "/api/users/2"] | [h: path = "/api/users/2"] | ||
| Line 36: | Line 37: | ||
<pre> | <pre> | ||
[r: json.indent(response, 2)] | [r: json.indent(response, 2)] | ||
</pre></ | </pre></syntaxhighlight> | ||
Returns: | Returns: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
{ | |||
</ | "name": "morpheus", | ||
"job": "zion resident", | |||
"updatedAt": "2019-03-17T22:49:52.188Z" | |||
} | |||
</syntaxhighlight> | |||
|also= | |also= | ||
[[RESTful | [[RESTful Functions Overview|RESTful Functions Overview]] | ||
}} | }} | ||
[[Category:RESTful Function]] | [[Category:RESTful Function]] | ||
Latest revision as of 23:59, 10 May 2023
REST.put() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5.0
Perform an HTTP put request to the specified URL to update an existing resource.
Usage
REST.put(url, payload, mediaType, getFullResponse)
REST.put(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.headers- JSON object containing header key:value pairs.getFullResponse- Boolean (0:1). Use 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.
Example
Update a user with a put request.
[h: baseURL = "https://reqres.in"]
[h: path = "/api/users/2"]
[h: mediaType = "application/json; charset=utf-8"]
[h: getFullResponse = 0]
[h: payload = '{ "name": "morpheus", "job": "zion resident" }']
[h: response = REST.put(baseURL + path, payload, mediaType, getFullResponse)]
<br>
<pre>
[r: json.indent(response, 2)]
</pre>Returns:
{
"name": "morpheus",
"job": "zion resident",
"updatedAt": "2019-03-17T22:49:52.188Z"
}