ws » patch(url,body,var)

Description

This command is used to send a HTTP PATCH request to the given endpoint url with the given request payload

To learn about how to utilize the response returned from the target URL, click here.

Expressing body as file content

Note that this command support automatic content resolution via:

• Fully qualified file path, or
• URL (GET only)
  • When the body parameter contains a valid URL, Nexial’s default behavior is to treat it as is(meaning, Nexial won’t resolve its content). One can instruct Nexial to automatically resolve the underlying content by setting the nexial.resolveTextAsURL to true.

When body is specified as a fully qualified file path or a valid URL, Nexial will attempt to extract the corresponding file content as the request payload. Such content can be resolved as text or binary content depending on the Content-Type header defined (via head(url,var)) prior to the execution of this command. Alternatively, one can enforce Nexial to treat the corresponding file content as binary via the nexial.ws.requestPayloadAsRaw System variable.

In addition, if the corresponding file content is to be treated as text, the following System variables may have some impact as well:

• nexial.resolveTextAsIs - to omit automatic data variable substitution
• nexial.ws.requestPayloadCompact - to trim off leading/trailing spaces from content

Parameters

• url - the target URL
• body - the request payload, or (empty) if none needed
• var - the variable to hold the response

Example

See Also

• delete(url,body,var)
• get(url,queryString,var)
• head(url,var)
• post(url,body,var)
• put(url,body,var)