Patch display template

1 min

PATCH

/_cms/v1/displaytemplates/{key}

Patch an existing display template.

Path Parameters

keystringrequired
Description
The key of the display template to patch.

Header Parameters

Preferstring[]
Example
```
[
  "return=representation"
]
```
Description
Indicates client preference for the response content as per IETF RFC7240. Currently only supports 'return=representation' which can be used to indicate a preference to receive a representation of the resource that has been altered in the response.
If-Matchstring
Description
If provided, the PATCH request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
If-Unmodified-Sincestring<http-date>
Description
If provided, the PATCH request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
Format
http-date

Responses

200OK

DisplayTemplate
Description
Describes a display template that can be assigned to content.
- keystring
  Description
  The unique identifier (key) of the resource.
  Min Length
  2
  Max Length
  255
  Pattern
  ^[A-Za-z][_0-9A-Za-z]+$
- displayNamestringrequired
  Description
  The display name of this display template.
  Min Length
  1
  Max Length
  255
- nodeTypestring
  Description
  The optional node type this display template is valid for.
  Min Length
  2
  Max Length
  50
  Pattern
  ^[A-Za-z][_0-9A-Za-z]+$
- baseTypestring
  Description
  The optional base type this display template is valid for.
- contentTypestring
  Description
  The optional key of the content type this display template is valid for.
- isDefaultboolean
  Description
  If this is the default display template for the associated base type, node type or content type.
- createdstring<date-time>
  Description
  A timestamp indicating when this display template was first created.
  Format
  date-time
- createdBystring
  Description
  The username of the user that created this display template.
- lastModifiedstring<date-time>
  Description
  A timestamp indicating when this display template was last modified.
  Format
  date-time
- lastModifiedBystring
  Description
  The username of the user that last modified this display template.
- settingsmap<string, DisplaySetting>
  Description
  The available settings for this display template.

Response Headers

ETagstring
Description
The RFC7232 ETag header field in a response provides the current entity-tag for the resource. An entity-tag is an opaque identifier for different versions of a resource over time, regardless whether multiple versions are valid at the same time.
Last-Modifiedstring<http-date>
Description
The date and time at which the resource was last modified.
Format
http-date
Preference-Applied

204No Content

400Bad Request

401Unauthorized

403Forbidden

404Not Found

412Precondition Failed

500Internal Server Error

curl

curl --request PATCH \
     --url /_cms/v1/displaytemplates/{key} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/merge-patch+json");

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/_cms/v1/displaytemplates/{key}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/_cms/v1/displaytemplates/{key}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/merge-patch+json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/_cms/v1/displaytemplates/{key}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/merge-patch+json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "key": "",
  "displayName": "",
  "nodeType": "",
  "baseType": "",
  "contentType": "",
  "isDefault": false,
  "created": "",
  "createdBy": "",
  "lastModified": "",
  "lastModifiedBy": "",
  "settings": ""
}

204

// No Content

400

// Bad Request

401

// Unauthorized

403

// Forbidden

404

// Not Found

412

// Precondition Failed

500

// Internal Server Error