Package com.atlassian.greenhopper.web.api

Class RankResource

java.lang.Object

com.atlassian.greenhopper.web.AbstractResource

com.atlassian.greenhopper.web.api.RankResource

@Path("api/rank")
@Produces("application/json")
@Consumes("application/json")
public class RankResource
extends AbstractResource

Since:

v5.8.1

Author:

mtokar

Field Summary

Fields inherited from class com.atlassian.greenhopper.web.AbstractResource

authenticationContext, log

Constructor Summary

Constructors

Constructor	Description
RankResource(RankHelper rankHelper)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	rankAfter(RankAfterRequest rankAfterRequest)	Attempts to rank issues after a specified issue, using the specified global rank custom field, via PUT method.
javax.ws.rs.core.Response	rankBefore(RankBeforeRequest rankBeforeRequest)	Attempts to rank issues before a specified issue, using the specified global rank custom field, via PUT method.

Methods inherited from class com.atlassian.greenhopper.web.AbstractResource

check, checkResult, createNoContentResponse, createOkResponse, createOkResponse, getUser, isGadgetRequest, nullSafe, response, responseWithoutAccessCheck

Methods inherited from class java.lang.Object

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

Constructor Details

RankResource

@Inject
public RankResource(RankHelper rankHelper)

Method Details

rankBefore

@PUT
@Path("before")
public javax.ws.rs.core.Response rankBefore(RankBeforeRequest rankBeforeRequest)

Attempts to rank issues before a specified issue, using the specified global rank custom field, via PUT method.

Issues can be specified using IDs or Keys. If both are specified, IDs will take precedence.

If the user does not have permission to rank any of the specified issues, no ranking operations will take place.

The specified custom field ID must refer to a Global Rank custom field.

Parameters:

rankBeforeRequest - the encoded request in application/json format

Returns:

RankResponse if successful; errors otherwise.

rankAfter

@PUT
@Path("after")
public javax.ws.rs.core.Response rankAfter(RankAfterRequest rankAfterRequest)

Attempts to rank issues after a specified issue, using the specified global rank custom field, via PUT method.

Issues can be specified using IDs or Keys. If both are specified, IDs will take precedence.

If the user does not have permission to rank any of the specified issues, no ranking operations will take place.

The specified custom field ID must refer to a Global Rank custom field.

Parameters:

rankAfterRequest - the encoded request in application/json format

Returns:

RankResponse if successful; errors otherwise.