YouTrack Standalone 2019.2 Help

Operations with Specific GlobalSettings

Provides operations with global application settings.

Resource

/api/admin/globalSettings

Returned entity

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

Supported methods

GlobalSettings attributes

Represents application-wide settings.

This table describes attributes of the GlobalSettings 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

systemSettings

SystemSettings

System settings that affect core functionality of YouTrack. Read-only.

notificationSettings

NotificationSettings

The Notifications settings of the YouTrack service. Read-only.

restSettings

RestCorsSettings

The Resource sharing (CORS) settings of the YouTrack service. Read-only.

appearanceSettings

AppearanceSettings

Visual settings of the YouTrack service. Read-only.

localeSettings

LocaleSettings

System language settings. Read-only.

license

License

License information. Read-only.

Read a Specific GlobalSettings

Get settings.

Request syntax

GET /api/admin/globalSettings?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of GlobalSettings 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?fields=appearanceSettings(dateFieldFormat(id,presentation),timeZone(id,presentation)),id,license(freeUsername,id,isFreeLicenseUsed),localeSettings(id,locale(id,locale,name)),restSettings(allowAllOrigins,allowedOrigins,hubServiceOrigins,id),systemSettings(allowStatisticsCollection,baseUrl,id,maxExportItems,maxOrderedIssues,maxUploadFileSize),updateInfo(id,isChecking,result(date,downloadUrl,id,message,success,updateAvailable))

Sample response body

{ "license": { "isFreeLicenseUsed": false, "freeUsername": "YouTrack Default", "id": "40-0", "$type": "License" }, "restSettings": { "allowAllOrigins": false, "allowedOrigins": [], "hubServiceOrigins": [], "id": "RestCorsSettings", "$type": "RestCorsSettings" }, "systemSettings": { "maxExportItems": 500, "allowStatisticsCollection": true, "maxUploadFileSize": 10485760, "baseUrl": "https://example.myjetbrains.com/youtrack", "id": "40-0", "$type": "SystemSettings" }, "updateInfo": { "result": { "updateAvailable": false, "success": true, "downloadUrl": null, "date": null, "message": "Update info is not available yet, check back later", "id": "update result", "$type": "CheckResult" }, "isChecking": false, "id": "UpdateInfo", "$type": "UpdateInfo" }, "appearanceSettings": { "dateFieldFormat": { "presentation": "Default date format (31 Dec 2000 23:59)", "id": "", "$type": "DateFormatDescriptor" }, "timeZone": { "presentation": "Central European Summer Time (UTC/GMT +2 hours)", "id": "Europe/Berlin", "$type": "TimeZoneDescriptor" }, "$type": "AppearanceSettings" }, "localeSettings": { "locale": { "name": "English", "id": "en_US", "locale": "en_US", "$type": "LocaleDescriptor" }, "id": "40-0", "$type": "LocaleSettings" }, "id": "GlobalSettings", "$type": "GlobalSettings" }

Update a Specific GlobalSettings

Update settings.

Required permissions

Requires Low-level Admin Write permission.

Request syntax

POST /api/admin/globalSettings?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of GlobalSettings 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?fields=appearanceSettings(dateFieldFormat(id,presentation),timeZone(id,presentation))

Sample request body

{ "appearanceSettings": { "timeZone": { "id": "Europe/Berlin" } } }

Sample response body

{ "appearanceSettings": { "timeZone": { "presentation": "Central European Summer Time (UTC/GMT +2 hours)", "id": "Europe/Berlin", "$type": "TimeZoneDescriptor" }, "dateFieldFormat": { "presentation": "Default date format (31 Dec 2000 23:59)", "id": "", "$type": "DateFormatDescriptor" }, "$type": "AppearanceSettings" }, "$type": "GlobalSettings" }
Last modified: 18 November 2019