YouTrack InCloud 2018.3 Help

Locales

The page describes a read-only resource that lets you read the list of locales that are supported by YouTrack server.

Resource

/api/admin/settings/locales

Returned entity

LocaleDescriptor. For the description of the entity attributes, see the Supported Fields section.

Supported methods

Supported Fields

This table describes attributes of the returned entity.

  • To receive an attribute in the response from server, specify it explicitly in the fields parameter of a request.

Field

Type

Description

community

Boolean

When true, the locale is custom and contributed by the community. Otherwise, the locale is officially provided and supported by JetBrains. By default, false.

language

String

A language identifier.

locale

String

A locale identifier.

name

String

A name of the locale displayed in the UI.

id

string

A unique entity ID.

Get a Date Formats List

Request syntax

GET /api/admin/locales[?{fields}&{$top}&{$skip}]

Reequest parameters

Parameter

Type

Description

fields

string

A list of LocaleDescriptor entity attributes that should be returned in the response. If no fields specified, only entity ID is returned.

$skip

int

Optional. Lets you set a number of returned entities to skip before returning the first one.

$top

int

Optional. Lets you specify the maximum number of entries that are returned in the response.

Sample request

curl -X GET \ 'https://example.myjetbrains.com/youtrack/api/admin/settings/locales?fields=id,name,community,language,locale' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache'

Sample response body

In a response to such sample request, you receive a list of all available locales entities with all their attributes:

[ { "name": "Español", "community": false, "locale": "es_ES", "language": "es", "id": "es_ES" }, { "name": "日本語", "community": false, "locale": "ja_JP", "language": "ja", "id": "ja_JP" }, { "name": "Русский", "community": false, "locale": "ru_RU", "language": "ru", "id": "ru_RU" }, { "name": "Français", "community": false, "locale": "fr_FR", "language": "fr", "id": "fr_FR" }, { "name": "English", "community": false, "locale": "en_US", "language": "en", "id": "en_US" }, { "name": "Deutsch", "community": false, "locale": "de_DE", "language": "de", "id": "de_DE" } ]
Last modified: 16 November 2018