Operations with Specific GlobalTimeTrackingSettings

This resource lets you configure system-wide time tracking settings.

Resource	/api/admin/timeTrackingSettings
Returned entity	GlobalTimeTrackingSettings. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific GlobalTimeTrackingSettings.

GlobalTimeTrackingSettings attributes

Represents time tracking settings of your server.

Related Resources

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

Global Time Tracking Settings

Attributes

This table describes attributes of the GlobalTimeTrackingSettings 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 server time tracking settings. `Read-only`.
workItemTypes	Array of WorkItemTypes	The list of available work item types. `Read-only`.
workTimeSettings	WorkTimeSettings	Server's work schedule settings. `Read-only`.
attributePrototypes	Array of WorkItemAttributePrototypes	The list of available work item attributes. `Read-only`.

Read a Specific GlobalTimeTrackingSettings

Read the time tracking settings of your service.

Required permissions

Requires permissions: Read Work Item

Request syntax

GET /api/admin/timeTrackingSettings?{fields}

Request parameters

Parameter	Type	Description
fields	String	A list of GlobalTimeTrackingSettings 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/timeTrackingSettings?fields=workItemTypes(name,autoAttached,id),workTimeSettings(daysAWeek,firstDatOfWeek,minutesADay,workDays,id)
            

Sample response body

                {
                  "workItemTypes": [
                    {
                      "autoAttached": true,
                      "name": "Development",
                      "id": "65-0",
                      "$type": "WorkItemType"
                    },
                    {
                      "autoAttached": true,
                      "name": "Testing",
                      "id": "65-1",
                      "$type": "WorkItemType"
                    },
                    {
                      "autoAttached": true,
                      "name": "Documentation",
                      "id": "65-2",
                      "$type": "WorkItemType"
                    },
                    {
                      "autoAttached": false,
                      "name": "R-n-D",
                      "id": "65-3",
                      "$type": "WorkItemType"
                    }
                  ],
                  "workTimeSettings": {
                    "minutesADay": 480,
                    "daysAWeek": 5,
                    "workDays": [
                      1,
                      2,
                      3,
                      4,
                      5
                    ],
                    "id": "64-0",
                    "$type": "WorkTimeSettings"
                  },
                  "$type": "GlobalTimeTrackingSettings"
                }
            

Last modified: 7 November 2024