Operations with Specific IssueWorkItem
Resource that provides access to work items.
Resource | |
|---|---|
Returned entity | IssueWorkItem. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
Represents a work item in an issue.
Below you can find the list of resources that let you work with this entity.
Extends BaseWorkItem
This table describes attributes of the IssueWorkItem entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the issue work item. |
author | The user to whom the work is attributed in the work item. | |
creator | The user who added the work item to the issue. | |
text | String | The work item description. |
textPreview | String | Parsed preview of the description. |
type | The work item type. | |
created | Long | The timestamp in milliseconds indicating the moment when the work item was created. Stored as a unix timestamp at UTC. |
updated | Long | The timestamp in milliseconds indicating the last update of the work item. Stored as a unix timestamp at UTC. |
duration | The duration of the work item. | |
date | Long | The timestamp in milliseconds indicating the date and time of the work item. Stored as a Unix timestamp in UTC. The time part is set to midnight for the current date. |
issue | Stores attributes of the issue to which the work item is attached. | |
attributes | The list of attributes of the work item. |
Get a specific work item.
Requires access to the issue work item is added to and Read Work Item permission.
GET /api/workItems/{itemID}?{fields}{itemID} | Database ID of the work item |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of IssueWorkItem attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/workItems/115-2?fields=created,duration(presentation,minutes),author(name),creator(name),date,id{
"duration": {
"minutes": 60,
"presentation": "1h",
"$type": "DurationValue"
},
"date": 1538956800000,
"created": 1539088817836,
"creator": {
"name": "John Doe",
"$type": "User"
},
"author": {
"name": "Jane Doe",
"$type": "User"
},
"id": "115-2",
"$type": "IssueWorkItem"
}