Package com.atlassian.jira.rest.v2.issue

Class LinkIssueResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.LinkIssueResource

@Path("issueLink")
@Consumes("application/json")
@Produces("application/json")
public class LinkIssueResource
extends Object

The Link Issue Resource provides functionality to manage issue links.

Since:

v4.3

Constructor Summary

Constructors

Constructor

Description

LinkIssueResource(ApplicationProperties applicationProperties, I18nHelper i18n, JiraAuthenticationContext authContext, PermissionManager permissionManager, IssueLinkManager issueLinkManager, CommentService commentService, ProjectRoleManager projectRoleManager, IssueLinkTypeFinder issueLinkTypeFinder, IssueFinder issueFinder, IssueLinkService issueLinkService, JiraBaseUrls jiraBaseUrls, IssueService issueService)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	deleteIssueLink(String linkId)	Deletes an issue link with the specified id.
jakarta.ws.rs.core.Response	getIssueLink(String linkId)	Returns an issue link with the specified id.
jakarta.ws.rs.core.Response	linkIssues(LinkIssueRequestJsonBean linkIssueRequestBean)	Creates an issue link between two issues.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LinkIssueResource

@Inject
public LinkIssueResource(ApplicationProperties applicationProperties,
 I18nHelper i18n,
 JiraAuthenticationContext authContext,
 PermissionManager permissionManager,
 IssueLinkManager issueLinkManager,
 CommentService commentService,
 ProjectRoleManager projectRoleManager,
 IssueLinkTypeFinder issueLinkTypeFinder,
 IssueFinder issueFinder,
 IssueLinkService issueLinkService,
 JiraBaseUrls jiraBaseUrls,
 IssueService issueService)

Method Details

linkIssues

@POST
public jakarta.ws.rs.core.Response linkIssues(LinkIssueRequestJsonBean linkIssueRequestBean)

Creates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link type in the request is used to create the link and will create a link from the first issue to the second issue using the outward description. It also create a link from the second issue to the first issue using the inward description of the issue link type. It will add the supplied comment to the first issue. The comment can have a restriction who can view it. If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment. The user who creates the issue link needs to belong to the specified group or have the specified role.

Parameters:

linkIssueRequestBean - contains all information about the link relationship. Which issues to link, which issue link type to use and and an optional comment that will be added to the first issue.

Returns:

a response indicating if the issue link was created successfully.

getIssueLink

@GET
@Path("{linkId}")
public jakarta.ws.rs.core.Response getIssueLink(@PathParam("linkId")
 String linkId)

Returns an issue link with the specified id.

Parameters:

linkId - the issue link id.

deleteIssueLink

@DELETE
@Path("{linkId}")
public jakarta.ws.rs.core.Response deleteIssueLink(@PathParam("linkId")
 String linkId)

Deletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission for at least one of the issues.

Parameters:

linkId - the issue link id.