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

Class IssueLinkTypeResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.IssueLinkTypeResource

@Path("issueLinkType")
@Consumes("application/json")
@Produces("application/json")
public class IssueLinkTypeResource
extends Object

Rest resource to retrieve a list of issue link types.

Constructor Summary

Constructors

Constructor	Description
IssueLinkTypeResource(IssueLinkTypeService issueLinkTypeService, JiraAuthenticationContext authenticationContext, I18nHelper i18n, AccessDisablingHelper accessDisablingHelper, javax.ws.rs.core.UriInfo contextUriInfo, com.atlassian.plugins.rest.api.util.RestUrlBuilder restUrlBuilder)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createIssueLinkType(IssueLinkTypeJsonBean linkTypeBean)	Create a new issue link type.
javax.ws.rs.core.Response	deleteIssueLinkType(String issueLinkTypeIdString)	Delete the specified issue link type.
javax.ws.rs.core.Response	getIssueLinkType(String issueLinkTypeIdString)	Returns for a given issue link type id all information about this issue link type.
javax.ws.rs.core.Response	getIssueLinkTypes()	Returns a list of available issue link types, if issue linking is enabled.
javax.ws.rs.core.Response	moveIssueLinkType(String issueLinkTypeIdString, IssueLinkTypeOrderUpdateRequest request)	Moves the issue link type across the others.
javax.ws.rs.core.Response	resetOrder(IssueLinkTypeResetOrderRequest request)	Resets the order of issue link types alphabetically.
javax.ws.rs.core.Response	updateIssueLinkType(String issueLinkTypeIdString, IssueLinkTypeJsonBean linkTypeJsonBean)	Update the specified issue link type.

Methods inherited from class java.lang.Object

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

Constructor Details

IssueLinkTypeResource

@Inject
public IssueLinkTypeResource(IssueLinkTypeService issueLinkTypeService,
 JiraAuthenticationContext authenticationContext,
 I18nHelper i18n,
 AccessDisablingHelper accessDisablingHelper,
 javax.ws.rs.core.UriInfo contextUriInfo,
 com.atlassian.plugins.rest.api.util.RestUrlBuilder restUrlBuilder)

Method Details

getIssueLinkTypes

@GET
public javax.ws.rs.core.Response getIssueLinkTypes()

Returns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship.

Returns:

a list of available issue link types.

createIssueLinkType

@POST
public javax.ws.rs.core.Response createIssueLinkType(IssueLinkTypeJsonBean linkTypeBean)

Create a new issue link type.

getIssueLinkType

@GET
@Path("/{issueLinkTypeId}")
public javax.ws.rs.core.Response getIssueLinkType(@PathParam("issueLinkTypeId")
 String issueLinkTypeIdString)

Returns for a given issue link type id all information about this issue link type.

Returns:

returns information about an issue link type. Containing the id, name and inward and outward description for this link.

deleteIssueLinkType

@DELETE
@Path("/{issueLinkTypeId}")
public javax.ws.rs.core.Response deleteIssueLinkType(@PathParam("issueLinkTypeId")
 String issueLinkTypeIdString)

Delete the specified issue link type.

Returns:

Returns NO_CONTENT if successful.

updateIssueLinkType

@PUT
@Path("/{issueLinkTypeId}")
public javax.ws.rs.core.Response updateIssueLinkType(@PathParam("issueLinkTypeId")
 String issueLinkTypeIdString,
 IssueLinkTypeJsonBean linkTypeJsonBean)

Update the specified issue link type.

moveIssueLinkType

@PUT
@Path("/{issueLinkTypeId}/order")
public javax.ws.rs.core.Response moveIssueLinkType(@PathParam("issueLinkTypeId")
 String issueLinkTypeIdString,
 IssueLinkTypeOrderUpdateRequest request)

Moves the issue link type across the others.

Returns:

Updated issue link type if the operation was successful.

resetOrder

@PUT
@Path("/order")
public javax.ws.rs.core.Response resetOrder(IssueLinkTypeResetOrderRequest request)

Resets the order of issue link types alphabetically.

Returns:

All issue link types if the order was reset successfully.