Edit a record of time spent
Use this request to edit 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 pass a time interval of 5 days (P5D
), the request will return the value 1 week (P1W
), which you'll see when viewing the issue.
Request format
To edit records of time spent on issues, use an HTTP PATCH
request: Request parameters are passed in the request body in JSON format:
PATCH /v2/issues/<issue-id>/worklog/<worklog-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <token>
X-Org-ID: <organization ID>
{
"duration": "PT520M",
"comment": "time changed!"
}
-
Host
API host address:
https://api.tracker.yandex.net
-
Authorization
OAuth token in
OAuth <token value>
format. For example:OAuth 0c4181a7c2cf4521964a72ff57a34a07
-
X-Org-ID
Organization ID.
Parameter | Description | Data type |
---|---|---|
<issues-id> | Issue ID or key. | String |
<worklog-id> | ID of the record of time spent. | String |
Required parameters
Parameter | Description | Data type |
---|---|---|
duration | Time spent, in PnYnMnDTnHnMnS, PnW format, according to the ISO 8601.Separate hours, minutes, and seconds from the rest using 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 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/v2/issues/TEST-324/worklog/1",
"id": 1,
"version": 1402121720882,
"issue": {
"self": "https://api.tracker.yandex.net/v2/issues/TEST-324",
"id": "515ec9eae4b09cfa984e2047",
"key": "TEST-324",
"display": "important issue"
},
"comment": "time changed!",
"createdBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000014909",
"id": "veikus",
"display": "Artem Veikus"
},
"updatedBy": {
"self": "https://api.tracker.yandex.net/v2/users/1120000000014909",
"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"
}
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 |
Object fields issue
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 |
Object fields createdBy
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the user. | String |
id | User ID. | String |
display | User's name displayed. | String |
Object fields updatedBy
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the user. | String |
id | User ID. | String |
display | User's name displayed. | String |
If a request fails, the response message contains details of the errors encountered:
- 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.