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.
", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "If-Match", "type": "string", "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.
" }, { "kind": "optional", "name": "If-Unmodified-Since", "type": "stringIf 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" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiAuth", "name": "apiAuth", "kind": "optional", "type": "oauth2", "description": "Use this scheme to generate an access token that can be used to access the API.", "oauth2Flows": { "clientCredentials": { "tokenUrl": "https://api.cms.optimizely.com/oauth/token", "scopes": { "api:admin": "Grants full administrative access to the API" } } }, "requiredScopes": [ "api:admin" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "ETag", "type": "string", "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.
" }, { "kind": "optional", "name": "Last-Modified", "type": "stringThe unique identifier (key) of the resource.
", "minLength": 2, "maxLength": 255, "pattern": "^[A-Za-z][_0-9A-Za-z]+$" }, { "name": "displayName", "kind": "required", "type": "string", "description": "The display name of this display template.", "minLength": 1, "maxLength": 255 }, { "name": "nodeType", "kind": "optional", "type": "string", "description": "The optional node type this display template is valid for.", "minLength": 2, "maxLength": 50, "pattern": "^[A-Za-z][_0-9A-Za-z]+$" }, { "name": "baseType", "kind": "optional", "type": "string", "nullable": true, "description": "The optional base type this display template is valid for.", "example": "_page", "examples": [ { "value": "_page" }, { "value": "_component" }, { "value": "_media" }, { "value": "_image" }, { "value": "_video" }, { "value": "_folder" }, { "value": "_experience" }, { "value": "_section" }, { "value": "_element" } ], "maxLength": 50 }, { "name": "contentType", "kind": "optional", "type": "string", "description": "The optional key of the content type this display template is valid for." }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "If this is the default display template for the associated base type, node type or content type.
" }, { "name": "created", "kind": "optional", "type": "stringA short, human-readable summary of the problem type.
" }, { "name": "status", "kind": "optional", "type": "integerA human-readable explanation specific to this occurrence of the problem.
" }, { "name": "instance", "kind": "optional", "type": "stringA granular explanation of one specific error related to a field, header or query parameter.
" }, { "name": "field", "kind": "optional", "type": "string", "nullable": true, "description": "A string that may provide a hint to which field that was the source of the error.", "example": "properties.header.displayName" } ] } ], "modelRef": "#/components/schemas/ProblemDetails", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "qd7AmRIpq201vbVqdgaAJ", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://api.cms.optimizely.com/v1/displaytemplates/{key} \\\n --header 'accept: application/json'" }, { "id": "1Eaq6IVORNYlirk3gfJAf", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/merge-patch+json\");\n\nvar requestOptions = {\n method: 'PATCH',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.cms.optimizely.com/v1/displaytemplates/{key}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "fQ2DixrXFP6dSSxOaomsZ", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.cms.optimizely.com/v1/displaytemplates/{key}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/merge-patch+json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "XoBVpCtzTYCj98oEdd92a", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.cms.optimizely.com/v1/displaytemplates/{key}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/merge-patch+json'\n}\n\nresponse = requests.request(\"PATCH\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "qd7AmRIpq201vbVqdgaAJ" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// OK\n{\n \"key\": \"\",\n \"displayName\": \"\",\n \"nodeType\": \"\",\n \"baseType\": \"_page\",\n \"contentType\": \"\",\n \"isDefault\": false,\n \"created\": \"\",\n \"createdBy\": \"\",\n \"lastModified\": \"\",\n \"lastModifiedBy\": \"\",\n \"settings\": \"\"\n}" }, { "id": "response-1-204", "language": "204", "code": "// No Content\n" }, { "id": "response-2-400", "language": "400", "code": "// Bad Request\n" }, { "id": "response-3-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-4-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-5-404", "language": "404", "code": "// Not Found\n" }, { "id": "response-6-412", "language": "412", "code": "// Precondition Failed\n" }, { "id": "response-7-429", "language": "429", "code": "// Too Many Requests\n{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"errors\": [\n {\n \"detail\": \"\",\n \"field\": \"properties.header.displayName\"\n }\n ]\n}" }, { "id": "response-8-500", "language": "500", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }