Package com.atlassian.jira.rest.v2.index

Class ReindexRequestResource

java.lang.Object
com.atlassian.jira.rest.v2.index.ReindexRequestResource
@Consumes("application/json") @Produces("application/json") @Path("reindex/request") public class ReindexRequestResource extends Object
REST resource for querying and executing reindex requests.
Since:
6.4

  • Constructor Details

    • ReindexRequestResource

      @Inject public ReindexRequestResource(ReindexRequestService reindexRequestService)

  • Method Details

    • processRequests

      @POST public javax.ws.rs.core.Response processRequests()
      Executes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests that are being processed. Execution is asynchronous - progress of the returned tasks can be monitored through other REST calls.
      Returns:
      JSON array containing the IDs of the reindex requests that are being processed.

    • getProgress

      @GET @Path("{requestId}") public javax.ws.rs.core.Response getProgress(@PathParam("requestId") long requestId)
      Retrieves the progress of a single reindex request.
      Parameters:
      requestId - the reindex request ID.
      Returns:
      details and status of the reindex request.

    • getProgressBulk

      @GET @Path("bulk") public List<ReindexRequestBean> getProgressBulk(@QueryParam("requestId") Set<Long> requestIds)
      Retrieves the progress of a multiple reindex requests. Only reindex requests that actually exist will be returned in the results.
      Parameters:
      requestIds - the reindex request IDs.
      Returns:
      an array of results describing the progress of each of the found requests.