Localisation

Localisation is controlled by the locale parameter. If no parameter is given, the response includes only the default language of the repository.

Possible values for locale are <languageKey> or all

Value	Function
<languageKey>, e.g. en_US	Returns the field values for the specified locale, or their fallback (if configured).
all	Returns all available locales as field value, prefixed by their language key. (See the response in the query example below).

Set localisation for query results

GET https://api.cmft.io/v1/<repoName>/<endpoint>?locale=<languageKey>

Path Parameters

Name	Type	Description
repoName	string	The API identifier of the repository
endpoint	string	The endpoint you'd like to request
locale	string	Provide the language Key, e.g. en_US or all

200

// Response with a specific language key or the default language
{
  "fields": {
    "title": "Roses are red"
  },
  "meta": {
    "id": "314159265358979323",
    "contentType": "poem",
    "repository": "314159265358979323",
    "revision": 1,
    "tags": [],
    "createdAt": "2018-01-01T00:00:00.000Z",
    "updatedAt": "2018-01-01T00:00:00.000Z"
  }
}

// Response with locale="all"
{
  "fields": {
    "title": {
      "en_US": "Roses are red",
      "de_DE": "Rosen sind rot"
    }
  },
  "meta": {
    "id": "314159265358979323",
    "contentType": "poem",
    "repository": "314159265358979323",
    "revision": 1,
    "tags": [],
    "createdAt": "2018-01-01T00:00:00.000Z",
    "updatedAt": "2018-01-01T00:00:00.000Z"
  }
}

Examples

Find some example on the collections example page:

Collections