Patch locale

1 min

PATCH

/_cms/v1/locales/{key}

Patch an existing locale.

Path Parameters

keystringrequired
Description
The key of the locale 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

Locale
Description
Represents a locale that can be used for content.
- keystringrequired
  Description
  The unique identifier (key) of the resource. This is the IETF BCP-47 language tag (e.g., "en", "en-US", "sv-SE").
  Min Length
  1
- displayNamestringrequired
  Description
  The display name of this locale.
  Min Length
  1
  Max Length
  255
- isEnabledboolean
  Description
  Indicates whether this locale is enabled and can be used to create content.
- routeSegmentstringrequired
  Description
  A string that represents the segment that should be used when routing or generate routes to the current locale
  Min Length
  1
  Max Length
  255
- sortOrderinteger<int32>
  Description
  A value that is used when sorting locales.
  Format
  int32
- accessRightsSecurityIdentity[]
  Description
  The 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.
  - namestringrequired
    Description
    The unique name of the user, role or application that this identifier references.
    Min Length
    1
    Max Length
    255
  - typestring<user | role | application>
    Description
    The type of the security entity that this identifier references. Will default to 'role' if not specified.
    Allowed
    userroleapplication
- createdstring<date-time>
  Description
  A timestamp indicating when this locale was first created.
  Format
  date-time
- createdBystring
  Description
  The username of the user that created this locale.
- lastModifiedstring<date-time>
  Format
  date-time
- lastModifiedBystring
  Description
  The username of the user that last modified this locale.

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/locales/{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/locales/{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/locales/{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/locales/{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": "",
  "isEnabled": false,
  "routeSegment": "",
  "sortOrder": "",
  "accessRights": [
    {
      "name": "",
      "type": ""
    }
  ],
  "created": "",
  "createdBy": "",
  "lastModified": "",
  "lastModifiedBy": ""
}

204

// No Content

400

// Bad Request

401

// Unauthorized

403

// Forbidden

404

// Not Found

412

// Precondition Failed

500

// Internal Server Error