Contact UsGet started

Adding a record of time spent

Written by
Updated at February 19, 2024

Use this request to add a record of the time spent on an issue.

Note

In Yandex Tracker, time spent is measured in business weeks (5 days) and business days (8 hours).

For example, if you transmit a time interval of 5 days (P5D), the request will return the value 1 week (P1W), which you will see when viewing the issue.

Request format

To create records of time spent on issues, use an HTTP POST request. Request parameters are provided in the request body in JSON format:

POST /v2/issues/<issue_ID_or_key>/worklog
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
  "start": "2021-09-21T15:30:00.000+0500",
  "duration": "P5DT20M",
  "comment": "important comment"
}
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Resource
Parameter Description Data type
<issue_ID_or_key> Issue ID or key. String
Request body parameters

Required parameters

Parameter Description Data type
start Date and time when work on the issue started, in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
duration Time spent, in PnYnMnDTnHnMnS, PnW format, according to the ISO 8601.

To separate hours, minutes, and seconds, use the letter T.

For example, the value P6W corresponds to an interval of 6 weeks (30 business days), the value PT300M to an interval of 300 minutes (5 hours), and the value P0Y0M30DT2H10M25S to an interval of 30 days, 2 hours, 10 minutes, and 25 seconds.		 String

Additional parameters

Parameter Description Data type
comment Text of the comment to the record. The comment is saved to the Time Spent report. String

Response format

If the request is successful, the API returns a response with code 201 Created.

The response body contains a JSON object with a record of the time spent on the issue.

{
  "self": "https://https://api.tracker.yandex.net/v2/issues/TEST-324/worklog/1",
  "id": 1,
  "version": 1402121720882,
  "issue": {
    "self": "https://https://api.tracker.yandex.net/v2/issues/TEST-324",
    "id": "515ec9eae4b09cfa********",
    "key": "TEST-324",
    "display": "important issue"
  },
  "comment": "important comment",
  "createdBy": {
    "self": "https://https://api.tracker.yandex.net/v2/users/66********",
    "id": "veikus",
    "display": "Artem Veikus"
  },
  "updatedBy": {
    "self": "https://https://api.tracker.yandex.net/v2/users/66********",
    "id": "veikus",
    "display": "Artem Veikus"
  },
  "createdAt": "2021-09-28T08:42:06.258+0000",
  "updatedAt": "2021-09-28T08:42:06.258+0000",
  "start": "2021-09-21T10:30:00.000+0000",
  "duration": "P1WT20M"
}
Response parameters
Parameter Description Data type
self Address of the API resource with a record of the time spent on the issue. String
id ID of the record of time spent. String
version Record version. Each change to the record increases its version number. String
issue Block with information about the issue. Object
comment Text of the comment to the record. The comment is saved to the Time Spent report. String
createdBy Object with information about the user who added the record. Object
updatedBy Object with information about the user who edited the record. Object
createdAt Record creation date and time in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
updatedAt Record update date and time in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
start Date and time when work on the issue started, in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
duration Time spent, in PnYnMnDTnHnMnS, PnW format, according to the ISO 8601.. String

issue object fields

Parameter Description Data type
self Address of the API resource with information about the issue. String
id Issue ID. String
key Issue key. String
display Issue name displayed. String

createdBy object fields

Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display Displayed user name. String

updatedBy object fields

Parameter Description Data type
self Address of the API resource with information about the user. String
id User ID. String
display Displayed user name. String

If the request is processed incorrectly, the API returns a message with error details:

400
One or more request parameters have an invalid value.
403
Insufficient rights to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
404
The requested object was not found. You may have specified an invalid object ID or key.
422
JSON validation error, the request is rejected.
500
Internal service error. Try resending your request in a few minutes.
503
The API service is temporarily unavailable.
Previous
Bulk changes to issue statuses
Next
Editing a record of time spent