YouTrack InCloud 2019.1 Help

Operations with Specific Issue

Resource

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

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.

draftComment

TODO provide documentation for type

A draft of the comment for the current user. null if the current user has no draft comments. Can be null.

tags

Array of IssueTags

The list of tags that are attached to an 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 TODO provide documentation for type

The custom fields that are used in an 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

List of subtasks of the issue. Read-only.

parent

IssueLink

Parent of the issue, null if issue has no parent. Read-only.

Update a Specific Issue

Request syntax

POST /api/admin/projects/{projectID}/issues/{issueID}?{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.

Read a Specific Issue

Request syntax

GET /api/admin/projects/{projectID}/issues/{issueID}?{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.

Delete a Specific Issue

Request syntax

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

Request parameters

Parameter

Type

Description

Last modified: 17 May 2019