Issues
Resource that provides access to issues.
Resource | |
Returned entity | Issue. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Supported sub-resources |
|
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. |
created | Long | The timestamp of the moment when the issue was created. |
updated | Long | The timestamp of the last update of the issue. |
resolved | Long | The timestamp of the moment when the issue was assigned a state that is considered to be resolved. Returns |
numberInProject | Long | The issue number in the project. |
project | Project | The project to which the issue is assigned. |
summary | String | The text that is entered as the issue summary. |
description | String | The text that is entered as the issue description. |
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). |
reporter | User | The user who reported (created) the issue. |
updater | User | The user who last updated the issue. |
draftOwner | User | Creator of this draft if issue is a draft, null if issue was already reported. |
isDraft | Boolean | true if issue is a draft, false if it was already reported. |
visibility | Visibility | Visibility settings of the issue. They describe who is allowed to see the issue. |
votes | Int | Number of votes for this issue. |
comments | Array of IssueComments | A list of comments for the issue. |
commentsCount | Long | A number of comments in the issue. |
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). |
externalIssue | ExternalIssue | Reference to the issue or similar object in an originating third-party system. |
customFields | Array of IssueCustomFields | The collection of custom fields that are present in the issue. |
voters | IssueVoters | Object that contains data about voters for the issue and for its duplicates. |
watchers | IssueWatchers | Object that contains data about users watching this issue or its duplicates. |
attachments | Array of IssueAttachments | The list of attachments in the issue. |
subtasks | IssueLink | The list of sub-tasks of the issue. |
parent | IssueLink | The parent issue for the current one. If the issue is not a sub-task of any issue, then |
Read a List of Issues
Get all issues that match specified query. If the query is not provided, the server returns all issues.
Request syntax
GET /api/issues?{fields}&{$top}&{$skip}&{query}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 |
$skip | Int | Optional. Lets you set a number of returned entities to skip before returning the first one. |
$top | Int | Optional. Lets you specify the maximum number of entries that are returned in the response. |
query | String | Issues search query. Read more about search syntax here: Search-and-Command-Attributes |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/issues?query=for:%20me%20%23Unresolved%20&fields=id,summary,description,reporter(login)Sample response body
[
{
"description": null,
"summary": "Sprint 3. Task 2",
"reporter": {
"login": "root",
"$type": "User"
},
"idReadable": "SP-38",
"id": "2-42",
"$type": "Issue"
},
{
"description": "Let's create new issue from REST API",
"summary": "Issue from REST #1",
"reporter": {
"login": "root",
"$type": "User"
},
"idReadable": "SP-7",
"id": "2-6",
"$type": "Issue"
}
]Add a New Issue
Create new issue.
Required permissions
Requires Create Issue permission.
Request syntax
POST /api/issues?{fields}&{draftId}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 |
draftId | String | ID of a draft to report as the new issue. If no |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/issues?fields=idReadableSample request body
{
"summary": "Houston!",
"description": "We have a problem!",
"project": {
"id": "0-0"
},
"customFields": [
{
"value": {
"name": "Critical"
},
"name": "Priority",
"id": "92-1",
"$type": "SingleEnumIssueCustomField"
}
]
}Sample response body
{
"idReadable": "SP-39",
"$type": "Issue"
}