Skip to main content

For an introduction into setting up RESTful hal+json refer to the set-up documentation.

PATCH command

Following on from the GET command, to patch a node to the site (currently staging) is quite quick.  To be able to PATCH an article, the member needs to have authority to do so.  All members can update their own content.  However, they cannot update any one else's content.

Outline of the details required to make a PATCH:

Request: {domain}/node/{nid}?_format=hal_json

Content-Type: application/hal+json

Accept: application/hal+json

Body: Only include the details that need updating.

{"_links":{
"type":{"href":"{domain}/rest/type/node/{type}"}},
"nid":[{"value":"{nid}"}],
"type":[{"target_id":"{type}"}]
}

Add to the body the required elements that need updating.

Example of a PATCH

Variables:

  • {domain} - stg.runningrival.com
  • {nid} - 4
  • {type} - challenges

Request: https://your-site.com/node/4?_format=hal_json

Content-Type: application/hal+json

Accept: application/hal+json

Body: 

{"_links":{
  "type":{"href":"https://your-site.com/rest/type/node/challenges"}},
  "title":[{"value":"Nandi UPDATED!"}],
  "nid":[{"value":"4"}],
  "type":[{"target_id":"challenges"}],
  "body":[{"value": "<h2>Updating the body area</h2><p>Adding a few more details for this section.</p>\r\n",
  "format": "full_html"}],
}