Operations with Specific AppearanceSettings

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

Resource	/api/admin/globalSettings/appearanceSettings
Returned entity	AppearanceSettings. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific AppearanceSettings. `POST`: Update a Specific AppearanceSettings.

AppearanceSettings attributes

Represents the Visual settings of the YouTrack service.

Related Resources

Below you can find the list of resources that let you work with this entity.

Appearance Settings

Attributes

This table describes attributes of the AppearanceSettings 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 AppearanceSettings. `Read-only`.
timeZone	TimeZoneDescriptor	Default application time zone
dateFieldFormat	DateFormatDescriptor	Default format for dates presentation.
logo	Logo	Application logo. `Read-only`.

Read a Specific AppearanceSettings

Read the Visual settings of your YouTrack service.

Request syntax

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

Request parameters

Parameter	Type	Description
fields	String	A list of AppearanceSettings attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.

Sample

Sample request

                https://example.youtrack.cloud/api/admin/globalSettings/appearanceSettings?fields=dateFieldFormat(datePattern,pattern,presentation),timeZone(id,presentation,offset)
            

Sample response body

                {
                  "timeZone": {
                    "presentation": "Moscow Standard Time (UTC/GMT +3 hours)",
                    "id": "Europe/Moscow",
                    "offset": 180,
                    "$type": "TimeZoneDescriptor"
                  },
                  "dateFieldFormat": {
                    "pattern": "d MMM yyyy HH:mm",
                    "presentation": "Default date format (31 Dec 2000 23:59)",
                    "datePattern": "d MMM yyyy",
                    "$type": "DateFormatDescriptor"
                  },
                  "$type": "AppearanceSettings"
                }
            

Update a Specific AppearanceSettings

Change the Visual settings of your YouTrack service.

Required permissions

Requires permissions: Low-level Admin Write

Request syntax

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

Request parameters

Parameter	Type	Description
fields	String	A list of AppearanceSettings attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.

Sample

Sample request

                https://example.youtrack.cloud/api/admin/globalSettings/appearanceSettings?fields=dateFieldFormat(id,presentation),timeZone(id,presentation)
            

Sample request body

                {
                  "timeZone": {
                    "id": "Europe/Moscow"
                  }
                }
            

Sample response body

                {
                  "timeZone": {
                    "presentation": "Moscow Standard Time (UTC/GMT +3 hours)",
                    "id": "Europe/Moscow",
                    "$type": "TimeZoneDescriptor"
                  },
                  "dateFieldFormat": {
                    "presentation": "Default date format (31 Dec 2000 23:59)",
                    "id": "",
                    "$type": "DateFormatDescriptor"
                  },
                  "$type": "AppearanceSettings"
                }
            

Last modified: 7 November 2024