Operations with Specific GlobalSettings
Provides operations with global application settings.
Resource |
|
Returned entity | GlobalSettings. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
GlobalSettings attributes
Represents application-wide settings.
Related Resources
Below you can find the list of resources that let you work with this entity.
Attributes
This table describes attributes of the GlobalSettings
entity.
To receive an attribute in the response from the server, specify it explicitly in the
fields
request parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
id | String | The ID of the GlobalSettings. |
systemSettings | SystemSettings | System settings that affect core functionality of YouTrack. |
notificationSettings | NotificationSettings | The Notifications settings of the YouTrack service. |
restSettings | RestCorsSettings | The Resource sharing (CORS) settings of the YouTrack service. |
appearanceSettings | AppearanceSettings | Visual settings of the YouTrack service. |
localeSettings | LocaleSettings | System language settings. |
license | License | License information. |
Read a Specific GlobalSettings
Get the global 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 |
Sample
Sample request
https://example.youtrack.cloud/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": {
"freeUsername": "YouTrack Default",
"isFreeLicenseUsed": true,
"id": "67-0",
"$type": "License"
},
"restSettings": {
"allowAllOrigins": false,
"allowedOrigins": [],
"hubServiceOrigins": [],
"id": "RestCorsSettings",
"$type": "RestCorsSettings"
},
"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",
"locale": "en_US",
"id": "en_US",
"$type": "LocaleDescriptor"
},
"id": "67-0",
"$type": "LocaleSettings"
},
"updateInfo": {
"result": {
"downloadUrl": null,
"success": true,
"updateAvailable": false,
"date": null,
"message": "Update info is not available yet, check back later",
"id": "update result",
"$type": "CheckResult"
},
"isChecking": false,
"id": "UpdateInfo",
"$type": "UpdateInfo"
},
"systemSettings": {
"baseUrl": "https://example.youtrack.cloud",
"maxExportItems": 500,
"maxUploadFileSize": 10485760,
"allowStatisticsCollection": true,
"id": "67-0",
"$type": "SystemSettings"
},
"id": "GlobalSettings",
"$type": "GlobalSettings"
}
Update a Specific GlobalSettings
Update settings.
Required permissions
Requires permissions: Low-level Admin Write
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 |
Sample
Sample request
https://example.youtrack.cloud/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"
}