List display templates

1 min

GET

https://api.cms.optimizely.com/v1/displaytemplates

List display templates using the provided parameters.

Query Parameters

pageIndexinteger<int32>
Description
Zero based index of the page that should be retrieved.
Format
int32
Minimum
0
Maximum
10000
pageSizeinteger<int32>
Description
The maximum items per page that should be retrieved.
Format
int32
Minimum
1
Maximum
10000

Responses

200OK

DisplayTemplatePage
Description
A single page of items in a paged collection, including paging metadata such as the current page index, page size, and an estimated total item count.
- itemsDisplayTemplate[]
  Description
  The items in this paged collection.
  - 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
    Examples
    _page
    _component
    _media
    _image
    _video
    _folder
    _experience
    _section
    _element
    Description
    The optional base type this display template is valid for.
    Max Length
    50
  - 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.
- pageIndexinteger<int32>
  Description
  The zero-based index of the current page.
  Format
  int32
- pageSizeinteger<int32>
  Description
  The number of items in each page. Not necessarily the same as the number of items in this page.
  Format
  int32
- totalCountinteger<int32>
  Description
  The estimated total number of items in the collection. May be omitted if the total count is unknown.
  Format
  int32

401Unauthorized

403Forbidden

429Too Many Requests

ProblemDetails
- typestring<uri>
  Description
  A URI reference that identifies the problem type.
  Format
  uri
- titlestring
  Description
  A short, human-readable summary of the problem type.
- statusinteger<int32>
  Description
  The HTTP status code generated by the origin server for this occurrence of the problem.
  Format
  int32
  Minimum
  100
  Maximum
  599
- detailstring
  Description
  A human-readable explanation specific to this occurrence of the problem.
- instancestring<uri>
  Description
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
  Format
  uri
- codestring
  Description
  Error code that identifies the problem type.
- errorsobject[]
  Description
  An array of error details with more detailed information about the problem.
  - detailstring
    Description
    A granular explanation of one specific error related to a field, header or query parameter.
  - fieldstring
    Example
    properties.header.displayName
    Description
    A string that may provide a hint to which field that was the source of the error.

Response Headers

Retry-Afternumber
Description
Indicates how long the client should wait before making a new request.

500Internal Server Error

curl

curl --request GET \
     --url https://api.cms.optimizely.com/v1/displaytemplates \
     --header 'accept: application/json'

javascript

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

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

fetch("https://api.cms.optimizely.com/v1/displaytemplates", 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("https://api.cms.optimizely.com/v1/displaytemplates")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "https://api.cms.optimizely.com/v1/displaytemplates"

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

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

print(response.text)

200

// OK
{
  "items": [
    {
      "key": "",
      "displayName": "",
      "nodeType": "",
      "baseType": "_page",
      "contentType": "",
      "isDefault": false,
      "created": "",
      "createdBy": "",
      "lastModified": "",
      "lastModifiedBy": "",
      "settings": ""
    }
  ],
  "pageIndex": "",
  "pageSize": "",
  "totalCount": ""
}

401

// Unauthorized

403

// Forbidden

429

// Too Many Requests
{
  "type": "",
  "title": "",
  "status": "",
  "detail": "",
  "instance": "",
  "code": "",
  "errors": [
    {
      "detail": "",
      "field": "properties.header.displayName"
    }
  ]
}

500

// Internal Server Error