Link Issues
This resource lets you read, add, and remove links to other issues for the current one.
Resource | /api/issues/{issueID}/links/{linkID}/issues |
Returned entity | Issue. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Issue attributes
Represents an issue in YouTrack.
Related Resources
Below you can find the list of resources that let you work with this entity.
Attributes
This table describes attributes of the Issue
entity.
To receive an attribute in the response from the server, specify it explicitly in the
fields
request parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
---|---|---|
id | String | The database ID of the issue. |
attachments | Array of IssueAttachments | The list of attachments in the issue. |
comments | Array of IssueComments | A list of comments for the issue. |
commentsCount | Int | The number of comments in the issue. |
created | Long | The timestamp in milliseconds indicating the moment when the issue was created. Stored as a unix timestamp at UTC. |
customFields | Array of IssueCustomFields | The collection of custom fields that are present in the issue. |
description | String | The issue description. |
draftOwner | User | The creator of the draft if the issue is a draft. |
externalIssue | ExternalIssue | Reference to the issue or similar object in an originating third-party system. |
idReadable | String | The issue ID as seen in the YouTrack interface. |
isDraft | Boolean | |
links | Array of IssueLinks | Issue links (for example, `relates to`, `parent for`, and so on). |
numberInProject | Long | The issue number in the project. |
parent | IssueLink | The parent issue for the current one. If the issue is not a sub-task of any issue, then |
pinnedComments | Array of IssueComments | The list of comments that are pinned in the issue. |
project | Project | The project where the issue belongs. |
reporter | User | The user who reported (created) the issue. |
resolved | Long | The timestamp in milliseconds indicating the moment when the issue was assigned a state that is considered to be resolved. Stored as a unix timestamp at UTC. |
subtasks | IssueLink | The list of sub-tasks of the issue. |
summary | String | The issue summary. |
tags | Array of Tags | The list of tags that are added to the issue. |
updated | Long | The timestamp in milliseconds indicating the last update of the issue. Stored as a unix timestamp at UTC. |
updater | User | The user who last updated the issue. |
visibility | Visibility | Visibility settings of the issue. They describe who is allowed to see the issue. |
voters | IssueVoters | Object that contains data about voters for the issue and for its duplicates. |
votes | Int | The sum of votes for this issue and votes for its duplicates. A reporter of a duplicate issue automatically becomes a voter for the main issue. |
watchers | IssueWatchers | Object that contains data about users watching this issue or its duplicates. |
wikifiedDescription | String | The issue description as shown in the UI after processing wiki/Markdown markup (including HTML markup). |
Read the List of Linked Issues
Get all issues that are linked to the current one with this link type.
The default issue sorting is
sort by: updated desc
.If you don't provide the
$top
parameter, the number of returned issues is limited to the Max issues to export value in the Global Settings of your YouTrack.
Request syntax
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. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |
Sample
Sample request
Sample response body
Add a New Link to the Issue
Link the current issue to another issue.
Required fields: id
- the database ID of the issue you're linking to the current one.
Put the ID of the link type into the URL as linkID
. To get the list of available link types and choose the one you need, send a GET request to /api/issueLinkTypes?fields=id,name
. For details, see Read a List of IssueLinkTypes.
If the chosen link type is directed, append a direction marker to the ID of the link type:
For an outward link, append the
s
marker. Example:80-1s
.For an inward link, append the
t
marker. Example:80-1t
.
If the chosen link type is not directed, use the link type ID without markers. Example: 80-1
.
Read more about issue link types here: Issue Link Types.
Required permissions
Requires permissions: Link Issue
Request syntax
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 |
muteUpdateNotifications | Boolean | Set this parameter to |