Editing a record of time spent

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

PATCH

https://api.tracker.yandex.net/v3/issues/<issue_ID>/worklog/<record_ID>

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 edit records of time spent on issues, use an HTTP PATCH request. In the request body, specify the parameters in JSON format:

PATCH /v3/issues/<issue_ID>/worklog/<worklog_ID>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "duration": "PT520M",
    "comment": "time changed!"
}
Headers

  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource
Parameter Description Data type
<issue_ID> Issue ID or key. String
<record_ID> ID of the record of time spent. String
Request body parameters

Required parameters

Parameter Description Data type
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 Report on time spent. String

Response format

If the request is successful, the API returns a response with code 200 OK.

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

{
  "self": "https://api.tracker.yandex.net/v3/issues/TEST-324/worklog/1",
  "id": 1,
  "version": 1402121720882,
  "issue": {
    "self": "https://api.tracker.yandex.net/v3/issues/TEST-324",
    "id": "515ec9eae4b09cfa********",
    "key": "TEST-324",
    "display": "important issue"
  },
  "comment": "time changed!",
  "createdBy": {
    "self": "https://api.tracker.yandex.net/v3/users/66********",
    "id": "veikus",
    "display": "Artem Veikus"
  },
  "updatedBy": {
    "self": "https://api.tracker.yandex.net/v3/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": "P1DT40M"
}
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 issue details. Map item
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. Map item
updatedBy Object with information about the user who edited the record. Map item
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
You are not authorized 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 again later.
503
The API service is temporarily unavailable.
Previous
Adding a record of time spent
Next
Deleting a record of time spent