Operations with Specific IssueWorkItem
This resource lets you work with work items in the specific issue.
Resource | |
Returned entity | IssueWorkItem. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
IssueWorkItem attributes
Represents a work item in an issue.
This table describes attributes of the IssueWorkItem entity.
To receive an attribute in the response from server, specify it explicitly in the request parameter
fields.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
author | User | The user to whom the work is attributed in the work item. |
creator | User | The user who added the work item to the issue. |
text | String | The work item description. |
textPreview | String | Parsed preview of the description. |
type | WorkItemType | The work item type. |
created | Long | The date when the work item was created. |
updated | Long | The date when the work item was last updated. |
duration | DurationValue | The duration of the work item. |
date | Long | The date and time that is assigned to the work item. Stored as a Unix timestamp in UTC. The time part is set to midnight for the current date. |
issue | Issue | Stores attributes of the issue to which the work item is attached. |
usesMarkdown | Boolean | Stores the format of the comment text. When |
Read a Specific IssueWorkItem
Get the specific work item of the issue.
Required permissions
Requires access to the issue work item is added to and Read Work Item permission.
Request syntax
GET /api/issues/{issueID}/timeTracking/workItems/{itemID}?{fields}{itemID} | Database ID of the work item. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueWorkItem attributes that should be returned in the response. If no field is specified,only the |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/issues/2-35/timeTracking/workItems/115-7?fields=author(id,name),creator(id,name),date,duration(id,minutes,presentation),id,name,type(id,name)Sample response body
{
"date": 1538956800000,
"duration": {
"id": "120",
"minutes": 120,
"presentation": "2h",
"$type": "DurationValue"
},
"type": {
"name": "Testing",
"id": "65-1",
"$type": "WorkItemType"
},
"creator": {
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"author": {
"name": "Jane Doe",
"id": "1-3",
"$type": "User"
},
"id": "115-7",
"$type": "IssueWorkItem"
}Update a Specific IssueWorkItem
Update the specific work item of the issue.
Required permissions
Requires Update Work Item permission if work item was created by the user and Update Not Own Work Item otherwise.
Request syntax
POST /api/issues/{issueID}/timeTracking/workItems/{itemID}?{fields}{itemID} | Database ID of the work item. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueWorkItem attributes that should be returned in the response. If no field is specified,only the |
Delete a Specific IssueWorkItem
Delete the specific work item in the issue.
Required permissions
Requires Update Work Item permission if work item was created by the user and Update Not Own Work Item otherwise.
Request syntax
DELETE /api/issues/{issueID}/timeTracking/workItems/{itemID}{itemID} | Database ID of the work item. |
Request parameters
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueWorkItem attributes that should be returned in the response. If no field is specified,only the |