YouTrack Standalone 2019.2 Help

Issues

This resource lets you work with issues within the particular project.

Resource

/api/admin/projects/{projectID}/issues

Returned entity

Issue. For the description of the entity attributes, see Supported Fields section.

Supported methods

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

Long

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 List of Issues

Get a list of all available issues in the specific project.

Request syntax

GET /api/admin/projects/{projectID}/issues?{fields}&{$top}&{$skip}

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

$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.

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/projects/0-0/issues?fields=id,idReadable,summary&$skip=30&$top=5

Sample response body

[ { "idReadable": "SP-35", "summary": "Task 1", "id": "2-37", "$type": "Issue" }, { "idReadable": "SP-36", "summary": "REST API lets you create issues!", "id": "2-38", "$type": "Issue" }, { "idReadable": "SP-37", "summary": "Sprint3. Task 1", "id": "2-40", "$type": "Issue" }, { "idReadable": "SP-38", "summary": "New summary", "id": "2-42", "$type": "Issue" }, { "idReadable": "SP-39", "summary": "Huston!", "id": "2-44", "$type": "Issue" } ]

Add a New Issue

Create a new issue in the specified project.

Required attributes: summary

Request syntax

POST /api/admin/projects/{projectID}/issues?{fields}

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/admin/projects/0-6/issues?fields=id,idReadable,summary,description

Sample request body

{ "summary": "Sample for api/admin/projects/:id/issues endpoint", "description": "This issue is a sample for creating an issue in particular project. Using the api/admin/projects resource." }

Sample response body

{ "description": "This issue is a sample for creating an issue in particular project. Using the api/admin/projects resource.", "idReadable": "RP-3", "summary": "Sample for api/admin/projects/:id/issues endpoint", "id": "2-71", "$type": "Issue" }
Last modified: 22 October 2019