Locale

Locale é a configuração de idioma que um Space oferece suporte. Cada Locale tem um código de idioma (code, por exemplo ko-KR, en-US), e os valores de campo de um Content ou Media são armazenados separadamente por Locale. O valor em coreano e o valor em inglês ficam lado a lado no mesmo campo, e na consulta você escolhe receber o valor do idioma desejado.

Esta página trata das operações de gerenciamento via CMA (Content Management API) para criar e alterar um Locale. A entrega somente leitura da lista de Locale publicados aos visitantes fica a cargo do CDA Locale.

Estrutura do recurso

A seguir está o Locale padrão da Space de demonstração ("English (United States)"). Junto com sys (propriedades de sistema), ele tem optional, a propriedade de corpo do Locale.

{
  "sys": {
    "id": "4PXRRUpIqJ1sdcqujzO7lYJD1sReNG",
    "type": "Locale",
    "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } },
    "name": "English (United States)",
    "default": true,
    "code": "en-US",
    "createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "createdAt": "2026-06-17T10:43:31.960Z",
    "updatedAt": "2026-06-17T10:43:31.960Z",
    "updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
    "version": 1
  },
  "optional": false
}

Chaves principais:

• code: o código de idioma deste Locale (por exemplo, en-US). Coloque este valor no parâmetro locale da consulta de Content, Media para receber os valores desse idioma. É definido na criação e não pode ser alterado depois.
• default: indica se este Locale é o Locale padrão da Space. Uma Space tem um Locale padrão, e somente nesse Locale o default é true.
• optional: indica se este Locale pode ser deixado vazio ao preencher um campo obrigatório (required). No exemplo acima é false, portanto não pode ficar vazio.
• fallbackCode: o code de outro Locale a consultar quando não há valor (opcional). Aparece na resposta somente quando está definido. No exemplo acima não está definido, por isso a chave não aparece.

Propriedades de sistema (sys) e corpo

space, createdBy, updatedBy entram no formato Refer ({ "sys": { "id", "type": "Refer", "targetType" } }).

Propriedades de corpo:

name é derivado automaticamente de code (por exemplo, ja-JP → "Japanese (Japan)"). Por isso, não inclua name no corpo de criação ou alteração.

Locale é um recurso de configuração sem conceito de publicação. Por isso, ao contrário de Content, Media, o sys não tem publish, archive, status, apenas version. O version aumenta a cada alteração do Locale.

Locale padrão, optional, fallback

Cada uma das três propriedades define o seguinte.

• default: indica se é o Locale padrão da Space. Uma Space tem apenas um padrão, e somente nesse Locale o default é true. Não é possível definir default na criação (um Locale recém-criado não é o padrão). Para mudar o padrão, defina default como true na alteração (PUT). Esse Locale então passa a ser o novo padrão, e o padrão anterior é desativado.
• optional: indica se este Locale pode ser deixado vazio ao preencher um campo obrigatório (required). Se optional for false, o valor desse idioma deve ser preenchido obrigatoriamente; se for true, pode ser deixado vazio.
• fallbackCode: o code de outro Locale a consultar quando não há valor. Se o Locale solicitado não tiver valor, a busca passa para o Locale indicado por fallbackCode. Se o Locale para o qual se passou também tiver fallbackCode, forma-se uma cadeia que continua. Se não for definido, a própria chave não aparece na resposta.

O comportamento detalhado do Locale padrão, do preenchimento obrigatório e do fallback é tratado em Multilíngue (conceito).

API

A URL base de todos os endpoints abaixo é https://cma.weegloo.com/v1, e é necessário um token Bearer que autentique no CMA no cabeçalho Authorization. Para alteração e alteração parcial, é preciso enviar também o cabeçalho X-Weegloo-Version (o sys.version do recurso atual) para o controle de concorrência otimista. A criação e a exclusão não têm esse cabeçalho.

Documentos relacionados

• CDA Locale: entrega da lista de Locale publicados aos visitantes (leitura).
• Multilíngue (conceito): regras de Locale padrão, optional, fallbackCode.
• Content: dados de corpo que armazenam valores de campo por Locale.