Operations with Specific Issue
Resource that provides access to issues.
Resource | |
|---|---|
Returned entity | Issue. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Represents an issue in YouTrack.
Below you can find the list of resources that let you work with this entity.
This table describes attributes of the Issue 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 database ID of the issue. |
attachments | The list of attachments in the issue. | |
comments | A list of comments for the issue. | |
commentsCount | Int | The number of comments in the issue. |
created | Long | The timestamp in milliseconds indicating the moment when the issue was created. Stored as a unix timestamp at UTC. |
customFields | The collection of custom fields that are present in the issue. | |
description | String | The issue description. |
draftOwner | The creator of the draft if the issue is a draft. | |
externalIssue | Reference to the issue or similar object in an originating third-party system. | |
idReadable | String | The issue ID as seen in the YouTrack interface. |
isDraft | Boolean |
|
links | Issue links (for example, `relates to`, `parent for`, and so on). | |
numberInProject | Long | The issue number in the project. |
parent | The parent issue for the current one. If the issue is not a sub-task of any issue, then | |
pinnedComments | The list of comments that are pinned in the issue. | |
project | The project where the issue belongs. | |
reporter | The user who reported (created) the issue. | |
resolved | Long | The timestamp in milliseconds indicating the moment when the issue was assigned a state that is considered to be resolved. Stored as a unix timestamp at UTC. |
subtasks | The list of sub-tasks of the issue. | |
summary | String | The issue summary. |
tags | The list of tags that are added to the issue. | |
updated | Long | The timestamp in milliseconds indicating the last update of the issue. Stored as a unix timestamp at UTC. |
updater | The user who last updated the issue. | |
visibility | Visibility settings of the issue. They describe who is allowed to see the issue. | |
voters | Object that contains data about voters for the issue and for its duplicates. | |
votes | Int | The sum of votes for this issue and votes for its duplicates. A reporter of a duplicate issue automatically becomes a voter for the main issue. |
watchers | Object that contains data about users watching this issue or its duplicates. | |
wikifiedDescription | String | The issue description as shown in the UI after processing wiki/Markdown markup (including HTML markup). |
Read an issue with specific ID.
Requires permissions: Read Issue. If issue visibility is limited to some users or groups, user should be a part of this set or have Override Visibility Restrictions permission. For issue reporter only Create Issue permission is required.
GET /api/issues/{issueID}?{fields}{issueID} | ID of the issue. You can specify either the database ID of the issue (for example, |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Issue attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/issues/SP-38?fields=id,summary,customFields(id,name,value(avatarUrl,buildLink,color(id),fullName,id,isResolved,localizedName,login,minutes,name,presentation,text)){
"summary": "Sprint 3. Task 2",
"customFields": [
{
"value": {
"localizedName": null,
"color": {
"id": "17",
"$type": "FieldStyle"
},
"name": "Normal",
"id": "67-3",
"$type": "EnumBundleElement"
},
"name": "Priority",
"id": "92-1",
"$type": "SingleEnumIssueCustomField"
},
{
"value": {
"localizedName": null,
"color": {
"id": "0",
"$type": "FieldStyle"
},
"name": "Bug",
"id": "67-5",
"$type": "EnumBundleElement"
},
"name": "Type",
"id": "92-2",
"$type": "SingleEnumIssueCustomField"
},
{
"value": {
"isResolved": false,
"localizedName": null,
"color": {
"id": "0",
"$type": "FieldStyle"
},
"name": "Open",
"id": "69-1",
"$type": "StateBundleElement"
},
"name": "State",
"id": "92-3",
"$type": "StateIssueCustomField"
},
{
"value": {
"login": "john.doe",
"avatarUrl": "/hub/api/rest/avatar/cd939d5e-4c15-4080-98cd-0cde0cb3c19f?s=48",
"fullName": "John Doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"name": "Assignee",
"id": "94-0",
"$type": "SingleUserIssueCustomField"
},
{
"value": null,
"name": "Subsystem",
"id": "92-0",
"$type": "SingleOwnedIssueCustomField"
},
{
"value": [],
"name": "Fix versions",
"id": "92-4",
"$type": "MultiVersionIssueCustomField"
},
{
"value": [],
"name": "Affected versions",
"id": "92-5",
"$type": "MultiVersionIssueCustomField"
},
{
"value": null,
"name": "Fixed in build",
"id": "92-6",
"$type": "SingleBuildIssueCustomField"
}
],
"id": "2-42",
"$type": "Issue"
}Update single issue.
Requires Create Issue permission for issue's reporter and Update Issue permission otherwise.
POST /api/issues/{issueID}?{fields}&{muteUpdateNotifications}{issueID} | ID of the issue. You can specify either the database ID of the issue (for example, |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Issue attributes that should be returned in the response. If no field is specified, only the |
muteUpdateNotifications | Boolean | Set this parameter to |
https://example.youtrack.cloud/api/issues/SP-38?fields=id,summary,customFields(id,name,value(avatarUrl,buildLink,color(id),fullName,id,isResolved,localizedName,login,minutes,name,presentation,text)){
"summary": "New summary",
"customFields": [
{
"value": {
"name": "Major"
},
"name": "Priority",
"id": "92-1",
"$type": "SingleEnumIssueCustomField"
}
]
}{
"summary": "New summary",
"customFields": [
{
"value": {
"localizedName": null,
"color": {
"id": "18",
"$type": "FieldStyle"
},
"name": "Major",
"id": "67-2",
"$type": "EnumBundleElement"
},
"name": "Priority",
"id": "92-1",
"$type": "SingleEnumIssueCustomField"
},
{
"value": {
"localizedName": null,
"color": {
"id": "0",
"$type": "FieldStyle"
},
"name": "Bug",
"id": "67-5",
"$type": "EnumBundleElement"
},
"name": "Type",
"id": "92-2",
"$type": "SingleEnumIssueCustomField"
},
{
"value": {
"isResolved": false,
"localizedName": null,
"color": {
"id": "0",
"$type": "FieldStyle"
},
"name": "Open",
"id": "69-1",
"$type": "StateBundleElement"
},
"name": "State",
"id": "92-3",
"$type": "StateIssueCustomField"
},
{
"value": {
"login": "john.doe",
"avatarUrl": "/hub/api/rest/avatar/cd939d5e-4c15-4080-98cd-0cde0cb3c19f?s=48",
"fullName": "John Doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"name": "Assignee",
"id": "94-0",
"$type": "SingleUserIssueCustomField"
},
{
"value": null,
"name": "Subsystem",
"id": "92-0",
"$type": "SingleOwnedIssueCustomField"
},
{
"value": [],
"name": "Fix versions",
"id": "92-4",
"$type": "MultiVersionIssueCustomField"
},
{
"value": [],
"name": "Affected versions",
"id": "92-5",
"$type": "MultiVersionIssueCustomField"
},
{
"value": null,
"name": "Fixed in build",
"id": "92-6",
"$type": "SingleBuildIssueCustomField"
}
],
"id": "2-42",
"$type": "Issue"
}Delete the issue. Note that this operation can not be undone.
Requires permissions: Delete Issue
DELETE /api/issues/{issueID}{issueID} | ID of the issue. You can specify either the database ID of the issue (for example, |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Issue attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/issues/2-5