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 DELETE 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 DELETE 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": "Preference-Applied", "description": "" } ], "schema": [ { "kind": "optional", "type": "object", "description": "A locale that can be used for content.", "customType": "Locale", "schema": [ { "name": "key", "kind": "required", "type": "string", "description": "The unique identifier (key) of the resource. This is the IETF BCP-47 language tag (e.g., \"en\", \"en-US\", \"sv-SE\").
", "minLength": 1 }, { "name": "displayName", "kind": "required", "type": "string", "description": "The display name of this locale.", "minLength": 1, "maxLength": 255 }, { "name": "isEnabled", "kind": "optional", "type": "boolean", "description": "Indicates whether this locale is enabled and can be used to create content." }, { "name": "routeSegment", "kind": "required", "type": "string", "description": "A string that represents the segment that should be used when routing or generate routes to the current locale", "minLength": 1, "maxLength": 255 }, { "name": "sortOrder", "kind": "optional", "type": "integerThe access rights assigned to this locale that defines who can create content in this locale. If no access rights are assigned, everyone will be able to create content in this locale. An empty array means that no user will be allowed to create or change content in this locale.
", "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 } ] }, { "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": "5Sg8MStHWpg2ii_76z3gA", "language": "curl", "label": "cURL", "code": "curl --request DELETE \\\n --url https://api.cms.optimizely.com/v1/locales/{key} \\\n --header 'accept: application/json'" }, { "id": "FosqB_gGLUmXm3tYA4hEG", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'DELETE',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.cms.optimizely.com/v1/locales/{key}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "-M8Jzr4uWzhNIK9GLNBdB", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.cms.optimizely.com/v1/locales/{key}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Delete.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "6V05oF71G3r3Kc8JDGpAv", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.cms.optimizely.com/v1/locales/{key}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "5Sg8MStHWpg2ii_76z3gA" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// OK\n{\n \"key\": \"\",\n \"displayName\": \"\",\n \"isEnabled\": false,\n \"routeSegment\": \"\",\n \"sortOrder\": \"\",\n \"accessRights\": [\n {\n \"name\": \"\",\n \"type\": \"user\"\n }\n ],\n \"created\": \"\",\n \"createdBy\": \"\",\n \"lastModified\": \"\",\n \"lastModifiedBy\": \"\",\n \"fallback\": \"\"\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": "" } ] }