YouTrack Standalone 2019.2 Help

Operations with Specific LocaleSettings

This resource lets you work with the system language settings of your YouTrack service.

Resource

/api/admin/globalSettings/localeSettings

Returned entity

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

Supported methods

LocaleSettings attributes

Represents the System Language settings.

This table describes attributes of the LocaleSettings entity.

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

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

locale

LocaleDescriptor

Current locale of YouTrack.

isRTL

Boolean

Indicates whether the current system language is right-to-left.

Read a Specific LocaleSettings

Read the current system language of your YouTrack service.

Request syntax

GET /api/admin/globalSettings/localeSettings?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of LocaleSettings attributes that should be returned in the response. If no field is specified,only the entityID is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/globalSettings/localeSettings?fields=locale(id,name,community,locale,language),isRTL

Sample response body

{ "locale": { "name": "English", "locale": "en_US", "community": false, "id": "en_US", "language": "en", "$type": "LocaleDescriptor" }, "isRTL": false, "$type": "LocaleSettings" }

Update a Specific LocaleSettings

Change the system language of your YouTrack service.

Required parameters: Database id of the target locale. It usually has the same value as the locale attribute.

Required permissions

Requires Low-level Admin Write permission.

Request syntax

POST /api/admin/globalSettings/localeSettings?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of LocaleSettings attributes that should be returned in the response. If no field is specified,only the entityID is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/globalSettings/localeSettings?fields=locale(id,name,community,locale,language),isRTL

Sample request body

{ "locale": { "id": "de_DE" } }

Sample response body

{ "locale": { "name": "Deutsch", "locale": "de_DE", "community": false, "id": "de_DE", "language": "de", "$type": "LocaleDescriptor" }, "isRTL": false, "$type": "LocaleSettings" }
Last modified: 18 November 2019