Operations with Specific Issue

Resource that provides access to issues.

Resource	/api/issues/{issueID}
Returned entity	Issue. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Read a Specific Issue. `POST`: Update a Specific Issue. `DELETE`: Delete a Specific Issue.

Issue attributes

Represents an issue in YouTrack.

This table describes attributes of the Issue 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
idReadable	String	The issue ID. `Read-only`.
created	Long	The timestamp of the moment when the issue was created. `Read-only`. `Can be null`.
updated	Long	The timestamp of the last update of the issue. `Read-only`. `Can be null`.
resolved	Long	The timestamp of the moment when the issue was assigned a state that is considered to be resolved. Returns `null`, if the issue is still in an unresolved state. `Read-only`. `Can be null`.
numberInProject	Long	The issue number in the project. `Read-only`.
project	Project	The project to which the issue is assigned. `Can be null`.
summary	String	The text that is entered as the issue summary. `Can be null`.
description	String	The text that is entered as the issue description. `Can be null`.
usesMarkdown	Boolean	When `true`, the issue description is parsed as Markdown. When `false`, the issue description is parsed as YouTrack Wiki. Changing this value does not transform the markup from one syntax to another.
wikifiedDescription	String	Issue description as it is shown in UI after processing with wiki/markdown (including HTML markup). `Read-only`.
reporter	User	The user who reported (created) the issue. `Read-only`. `Can be null`.
updater	User	The user who last updated the issue. `Read-only`. `Can be null`.
draftOwner	User	Creator of this draft if issue is a draft, null if issue was already reported. `Read-only`. `Can be null`.
isDraft	Boolean	true if issue is a draft, false if it was already reported. `Read-only`.
visibility	Visibility	Visibility settings of the issue. They describe who is allowed to see the issue. `Can be null`.
votes	Int	Number of votes for this issue. `Read-only`.
comments	Array of IssueComments	A list of comments for the issue.
commentsCount	Int	A number of comments in the issue. `Read-only`.
tags	Array of IssueTags	The list of tags that are added to the issue.
links	Array of IssueLinks	Issue links (for example, `relates to`, `parent for`, and so on). `Read-only`.
externalIssue	ExternalIssue	Reference to the issue or similar object in an originating third-party system. `Read-only`. `Can be null`.
customFields	Array of IssueCustomFields	The collection of custom fields that are present in the issue. `Read-only`.
voters	IssueVoters	Object that contains data about voters for the issue and for its duplicates. `Read-only`.
watchers	IssueWatchers	Object that contains data about users watching this issue or its duplicates. `Read-only`.
attachments	Array of IssueAttachments	The list of attachments in the issue.
subtasks	IssueLink	The list of sub-tasks of the issue. `Read-only`.
parent	IssueLink	The parent issue for the current one. If the issue is not a sub-task of any issue, then `null`. `Read-only`.

Read a Specific Issue

Read an issue with specific ID.

Required permissions

Requires Read Issue permission. 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.

Request syntax

GET /api/issues/{issueID}?{fields}

{issueID}

ID of the issue. You can specify either the database ID of the issue (for example, 2-24) or issue ID in the project (for example, TST-5).

Request parameters

Parameter	Type	Description
fields	String	A list of Issue attributes that should be returned in the response. If no field is specified,only the `entityID` is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/issues/SP-38?fields=id,summary,customFields(id,name,value(avatarUrl,buildLink,color(id),fullName,id,isResolved,localizedName,login,minutes,name,presentation,text))
            

Sample response body

{
  "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 a Specific Issue

Update single issue.

Required permissions

Requires Create Issue permission for issue's reporter and Update Issue permission otherwise.

Request syntax

POST /api/issues/{issueID}?{fields}

{issueID}

ID of the issue. You can specify either the database ID of the issue (for example, 2-24) or issue ID in the project (for example, TST-5).

Request parameters

Parameter	Type	Description
fields	String	A list of Issue attributes that should be returned in the response. If no field is specified,only the `entityID` is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/issues/SP-38?fields=id,summary,customFields(id,name,value(avatarUrl,buildLink,color(id),fullName,id,isResolved,localizedName,login,minutes,name,presentation,text))
            

Sample request body

{
  "summary": "New summary",
  "customFields": [
    {
      "value": {
        "name": "Major"
      },
      "name": "Priority",
      "id": "92-1",
      "$type": "SingleEnumIssueCustomField"
    }
  ]
}
            

Sample response body

{
  "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 a Specific Issue

Delete the issue. Note that this operation can not be undone.

Required permissions

Requires Delete Issue permission.

Request syntax

DELETE /api/issues/{issueID}

{issueID}

ID of the issue. You can specify either the database ID of the issue (for example, 2-24) or issue ID in the project (for example, TST-5).

Request parameters

Parameter	Type	Description
fields	String	A list of Issue attributes that should be returned in the response. If no field is specified,only the `entityID` is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/issues/2-5

Last modified: 1 July 2020