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

Class StatusResource

java.lang.Object

com.atlassian.jira.rest.v2.issue.StatusResource

@Path("status")
@Consumes("application/json")
@Produces("application/json")
public class StatusResource
extends Object

Since:

4.2

Constructor Summary

Constructors

Constructor	Description
StatusResource(JiraAuthenticationContext authContext, ConstantsService constantsService, StatusHelper statusHelper, JiraBaseUrls jiraBaseUrls, StatusService statusService)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getPaginatedStatuses(Long startAt, Integer maxResults, String query, Set<Long> projectIds, Set<String> issueTypeIds)	Returns paginated list of filtered statuses
jakarta.ws.rs.core.Response	getStatus(String idOrName, jakarta.ws.rs.core.Request request, jakarta.ws.rs.core.UriInfo uriInfo)	Returns a full representation of the Status having the given id or name.
jakarta.ws.rs.core.Response	getStatuses(jakarta.ws.rs.core.Request request, jakarta.ws.rs.core.UriInfo uriInfo)	Returns a list of all statuses

Methods inherited from class java.lang.Object

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

Constructor Details

StatusResource

@Inject
public StatusResource(JiraAuthenticationContext authContext,
 ConstantsService constantsService,
 StatusHelper statusHelper,
 JiraBaseUrls jiraBaseUrls,
 StatusService statusService)

Method Details

getStatuses

@GET
public jakarta.ws.rs.core.Response getStatuses(@Context
 jakarta.ws.rs.core.Request request,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Returns a list of all statuses

Parameters:

request - a Request

uriInfo - a UriInfo

Returns:

a full representation of the Status

Since:

5.0

getStatus

@GET
@Path("{idOrName}")
public jakarta.ws.rs.core.Response getStatus(@PathParam("idOrName")
 String idOrName,
 @Context
 jakarta.ws.rs.core.Request request,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Returns a full representation of the Status having the given id or name.

Parameters:

idOrName - a numeric Status id or a status name

request - a Request

uriInfo - a UriInfo

Returns:

a full representation of the Status

getPaginatedStatuses

@GET
@Path("page")
@Produces("application/json")
@ExperimentalApi
public jakarta.ws.rs.core.Response getPaginatedStatuses(@DefaultValue("0") @QueryParam("startAt")
 Long startAt,
 @DefaultValue("100") @QueryParam("maxResults")
 Integer maxResults,
 @DefaultValue("") @QueryParam("query")
 String query,
 @QueryParam("projectIds")
 Set<Long> projectIds,
 @QueryParam("issueTypeIds")
 Set<String> issueTypeIds)

Returns paginated list of filtered statuses

Parameters:

startAt - the index of the first status to return

maxResults - the maximum number of statuses to return

query - the string that status names will be matched with

projectIds - the list of project ids to filter statuses

issueTypeIds - the list of issue type ids to filter statuses

Since:

9.2