WebMethod.Patch

Updated on

WebMethod.Patch (“PATCH”) is an enumeration that specifies the PATCH method for HTTP. It is a member of the WebMethod.Type that specifies an HTTP method.

Examples

The PATCH method is used to apply partial modifications to a resource on the server. Unlike POST, which is used for creating new resources, or PUT, which replaces a resource entirely, PATCH allows you to update only certain parts of a resource.

Use the PATCH method when you want to:

  • Update a specific field in a database record without affecting other fields.
  • Modify settings or configurations partially.
  • Revise a portion of a document or file.

Imagine you want to update the email address of an existing user in a database. The code could look like this:

WebAction.Request(
  WebMethod.Patch,
  "https://api.example.com/users/123"
)

Here, the PATCH request is made to “https://api.example.com/users/123”. It targets the user with the ID of 123 for a partial update, like changing just the email address without touching other fields.

By using the PATCH method, you inform the server that you wish to make specific changes to an existing resource without affecting the rest of it.

These enumerations only work in the context of custom connectors.

Other related enumerations are:

Applies to

Here’s a list of functions that work with WebMethod.Type:

Contribute » | Contributors: Rick de Groot