YouTrack Standalone 2018.2 Help

Get an Issue

GET /issue/{issue}

Get issue by id

GET /rest/issue/{issue}?{wikifyDescription}

Request parameters:

Name

Type

Description

issue

issueById

ID of an issue to get.

wikifyDescription

boolean

Optional. If '

true
', then issue description in the response should be formatted ("wikified"). For example, the request URL with this parameter should look as follows: "
/rest/issue/jt-23?wikifyDescription=true
". By default, this parameter is '
false
' and skipped in the URL.

Response parameters:

Name

Description

id

Issue id in database

jiraId

If issue was imported from Jira, represents id, that it have in Jira

projectShortName

Short name of the issue's project

numberInProject

Number of issue in project

summary

Summary of the issue

description

Description of the issue

created

Time when issue was created (the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date).

updated

Time when issue was last updated (the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date).

updaterName

Login of the user, that was the last, who updated the issue

resolved

If the issue is resolved, shows time, when resolved state was last set to the issue (the number of milliseconds since January 1, 1970, 00:00:00 GMT represented by this date).

reporterName

Login of user, who created the issue

voterName

Login of user, that voted for issue

commentsCount

Number of comments in issue

votes

Number of votes for issue

permittedGroup

User group, that has permission to read this issue; if group is not set, it means that any user has access to this issue

comment

Represents issue comment (see Get Comments of an Issue)

tag

Tags, accessible to logged in user

field

Represent any field of the issue including custom fields (depending on name attribute). Number and type of fields depends on project settings.

Samples

Sample 1

Request

GET http://localhost:8081/rest/issue/HBR-63 Cookie: $Version=0; JSESSIONID=mk665rg7fe03cd1ma539knqg; $Path=/; jetbrains.charisma.main.security.PRINCIPAL=MTVhMjY2OGUxMTUxMTI5MGMzNjhlZWM5NTJiNGJkNmIyNzc3NjdjZmM3YWU4MTVjYzQwYWE1MWZlYTkwNTcxNzphcHBfZXhjZXB0aW9u; $Path=/

Response

HTTP/1.1 200 OK Content-Type: application/xml;charset=UTF-8 Content-Length: 1994 <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <issue id="HBR-63"> <field name="attachments"> <value url="/_persistent/uploadFile.html?file=45-46&amp;v=0&amp;c=true">uploadFile.html</value> </field> <comment id="42-306" author="root" issueId="HBR-63" deleted="false" text="comment 1!" shownForIssueAuthor="false" created="1267030230127"> <replies/> </comment> <comment id="42-307" author="root" issueId="HBR-63" deleted="false" text="comment 2?" shownForIssueAuthor="false" created="1267030238721" updated="1267030230127"> <replies/> </comment> <field name="Priority"> <value>Normal</value> </field> <field name="Type"> <value>Bug</value> </field> <field name="State"> <value>Won't fix</value> </field> <field name="Assignee"> <value>beto</value> </field> <field name="Subsystem"> <value>Configuration</value> </field> <field name="Fix versions"> <value>2.0</value> <value>2.0.5</value> <value>2.0.7</value> </field> <field name="cf"> <value>0</value> <value>!</value> </field> <field name="scf"> <value>1265835603000</value> </field> <field name="links"> <value type="Depend" role="depends on">HBR-62</value> <value type="Duplicate" role="duplicates">HBR-57</value> <value type="Duplicate" role="is duplicated by">HBR-54</value> <value type="Relates" role="relates to">HBR-49</value> <value type="Relates" role="is related to">HBR-51</value> <value type="Depend" role="is required for">HBR-49</value> </field> <field name="projectShortName"> <value>HBR</value> </field> <field name="numberInProject"> <value>63</value> </field> <field name="summary"> <value>summary</value> </field> <field name="description"> <value>description</value> </field> <field name="created"> <value>1262171005630</value> </field> <field name="updated"> <value>1267630833573</value> </field> <field name="updaterName"> <value>root</value> </field> <field name="resolved"> <value>1267030108251</value> </field> <field name="reporterName"> <value>root</value> </field> <field name="commentsCount"> <value>2</value> </field> <field name="votes"> <value>0</value> </field> </issue>

Sample 2

Request

GET http://localhost:8081/rest/issue/HBR-650 Cookie: $Version=0; JSESSIONID=mk665rg7fe03cd1ma539knqg; $Path=/; jetbrains.charisma.main.security.PRINCIPAL=MTVhMjY2OGUxMTUxMTI5MGMzNjhlZWM5NTJiNGJkNmIyNzc3NjdjZmM3YWU4MTVjYzQwYWE1MWZlYTkwNTcxNzphcHBfZXhjZXB0aW9u; $Path=/

Response

HTTP/1.1 404 Not Found Content-Type: application/xml;charset=UTF-8 Content-Length: 86 <?xml version="1.0" encoding="UTF-8" standalone="yes"?><error>Issue not found.</error>
Last modified: 9 October 2018