Developer Portal for YouTrack and Hub Help

Operations with Specific TimeTrackingUserProfile

This resource lets you configure the time tracking settings in the user's profile.

Resource

/api/users/{userID}/profiles/timetracking

Returned entity

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

Supported methods

TimeTrackingUserProfile attributes

Represents time tracking settings in the user's profile.

This table describes attributes of the TimeTrackingUserProfile 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 time tracking settings in the user's profile. Read-only.

periodFormat

PeriodFieldFormat

Format, in which period values are displayed for the user.

Read a Specific TimeTrackingUserProfile

Get user's time tracking settings.

Required permissions

Requires permissions: Read Self to read own profile and Read User Full to read profile of another user.

Request syntax

GET /api/users/{userID}/profiles/timetracking?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of TimeTrackingUserProfile 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/users/me/profiles/timetracking?fields=periodFormat(id)

Sample response body

{ "periodFormat": { "id": "HOURS_MINUTES", "$type": "PeriodFieldFormat" }, "$type": "TimeTrackingUserProfile" }

Update a Specific TimeTrackingUserProfile

Update user's time tracking settings.

Required permissions

Requires permissions: Update Self to update own profile and Update User to update profile of another user.

Request syntax

POST /api/users/{userID}/profiles/timetracking?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of TimeTrackingUserProfile 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/users/me/profiles/timetracking?fields=periodFormat(id)

Sample request body

{ "periodFormat": { "id": "FULL" } }

Sample response body

{ "periodFormat": { "id": "FULL", "$type": "PeriodFieldFormat" }, "$type": "TimeTrackingUserProfile" }
Last modified: 30 May 2022