Package com.xebialabs.xlrelease.api.v1

# Interface PlannerApi

All Superinterfaces:
  `ApiService`

@Path("/api/v1/analytics/planner") @Consumes("application/json") @Produces("application/json") public interface PlannerApi extends ApiService

- ## Field Summary

  ### Fields inherited from interface com.xebialabs.xlrelease.api.ApiService

  `DEFAULT_RESULTS_PER_PAGE, DEFAULT_RESULTS_PER_PAGE_STRING, DEPTH, ORDER_BY, PAGE, PAGE_IS_OFFSET, RESULTS_PER_PAGE, ROLE_IDS_DATA`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `List<ProjectedRelease>`
  `getActiveReleases(Long page, Long resultsPerPage, String kind)`
  `List<ProjectedRelease>`
  `getCompletedReleases(Long page, Long resultsPerPage, Long sinceMillis, String kind)`
  `List<ProjectedRelease>`
  `getReleasesByIds(List<String> releaseIds)`
  `default String`
  `serviceName()`

- ## Method Details

  - ### serviceName

    default String serviceName()
    Specified by:
      `serviceName` in interface `ApiService`

  - ### getActiveReleases

    @GET @Path("/active") List<ProjectedRelease> getActiveReleases(@DefaultValue("0") @QueryParam("page") Long page, @DefaultValue("100") @QueryParam("resultsPerPage") Long resultsPerPage, @DefaultValue("RELEASE") @QueryParam("kind") String kind)

  - ### getCompletedReleases

    @GET @Path("/completed") List<ProjectedRelease> getCompletedReleases(@DefaultValue("0") @QueryParam("page") Long page, @DefaultValue("100") @QueryParam("resultsPerPage") Long resultsPerPage, @DefaultValue("0") @QueryParam("since") Long sinceMillis, @DefaultValue("RELEASE") @QueryParam("kind") String kind)

  - ### getReleasesByIds

    @POST @Path("/byIds") List<ProjectedRelease> getReleasesByIds(List<String> releaseIds)