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 content type.", "minLength": 1, "maxLength": 255 }, { "name": "description", "kind": "optional", "type": "string", "description": "A description of this content type.", "maxLength": 255 }, { "name": "baseType", "kind": "optional", "type": "string", "nullable": true, "description": "The base type of this content type. Ignored for contracts; required for all other content types.
", "example": "_page", "examples": [ { "value": "_page" }, { "value": "_component" }, { "value": "_media" }, { "value": "_image" }, { "value": "_video" }, { "value": "_folder" }, { "value": "_experience" }, { "value": "_section" }, { "value": "_element" } ], "maxLength": 50 }, { "name": "isContract", "kind": "optional", "type": "boolean", "description": "Specifies if the content type is a contract type." }, { "name": "source", "kind": "optional", "type": "string", "readOnly": true, "description": "A string that indicates the source of this content type. Can be used to distinguish content types created by the system from types coming from model classes in the CMS solution." }, { "name": "sortOrder", "kind": "optional", "type": "integerConfigures the built-in composition (the \"canvas\") for experience and section content types. Only applicable when BaseType is _experience or _section.
The layout type to use for the built-in composition (e.g. outline or grid). When empty, the default layout for the base type is used.
Content types and base types that the built-in composition is permitted to contain.
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "restrictedTypes", "kind": "optional", "type": "array", "description": "Content types and base types that the built-in composition is forbidden from containing.
", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" } ] }, { "name": "contracts", "kind": "optional", "type": "array", "description": "Provides a set of contract content types that this content type is bound to.", "example": "", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "created", "kind": "optional", "type": "stringThe access rights assigned to this content type that defines who can create content of this type. If no access rights are assigned, everyone will be able to create content of this type. An empty array means that no new content of this type can be created.
", "modelRef": "#/components/schemas/SecurityIdentity", "customType": "SecurityIdentity[]", "schema": [ { "name": "name", "kind": "required", "type": "string", "description": "The unique name of the user, role or application that this identifier references.
", "minLength": 1, "maxLength": 255 }, { "name": "type", "kind": "optional", "type": "string", "description": "The type of the security entity that this identifier references. Will default to 'role' if not specified.", "example": "user", "examples": [ { "value": "user" }, { "value": "role" }, { "value": "application" } ], "maxLength": 50 } ] } ], "modelRef": "#/components/schemas/ContentType", "isExpanded": true } ] }, { "statusCode": "204", "description": "No Content", "jsonExample": "", "isExpanded": true }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true }, { "statusCode": "412", "description": "Precondition Failed", "jsonExample": "", "isExpanded": true }, { "statusCode": "429", "description": "Too Many Requests", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "Retry-After", "type": "number", "description": "Indicates how long the client should wait before making a new request." } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ProblemDetails", "schema": [ { "name": "type", "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": "BUtuVENnbTea-TlZDqxyD", "language": "curl", "label": "cURL", "code": "curl --request PATCH \\\n --url https://api.cms.optimizely.com/v1/contenttypes/{key} \\\n --header 'accept: application/json'" }, { "id": "6ZCXiDU6pe5Xd5E1Q7ryp", "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/contenttypes/{key}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "KGdMIAKG5fcUjxUz9udE_", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.cms.optimizely.com/v1/contenttypes/{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": "z2rqBC-MqQ9UwyUQFPXiN", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.cms.optimizely.com/v1/contenttypes/{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": "BUtuVENnbTea-TlZDqxyD" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// OK\n{\n \"key\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"baseType\": \"_page\",\n \"isContract\": false,\n \"source\": \"\",\n \"sortOrder\": \"\",\n \"mayContainTypes\": [\n \"\"\n ],\n \"mediaFileExtensions\": [\n \"\"\n ],\n \"compositionBehaviors\": [\n \"\"\n ],\n \"composition\": {\n \"format\": \"\",\n \"allowedTypes\": [\n \"\"\n ],\n \"restrictedTypes\": [\n \"\"\n ]\n },\n \"contracts\": [\n \"\"\n ],\n \"created\": \"\",\n \"createdBy\": \"\",\n \"lastModified\": \"\",\n \"lastModifiedBy\": \"\",\n \"properties\": \"\",\n \"accessRights\": [\n {\n \"name\": \"\",\n \"type\": \"user\"\n }\n ]\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": "" } ] }