Package com.xebialabs.xlrelease.api.v1

Interface ReleaseGroupApi

All Superinterfaces:

ApiService

@Path("/api/v1/release-groups")
@Produces("application/json")
@Consumes("application/json")
public interface ReleaseGroupApi
extends ApiService

Operations on release groups.

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
void	addMembersToGroup(java.lang.String groupId, java.util.List<java.lang.String> memberIds)
com.xebialabs.xlrelease.domain.group.ReleaseGroup	createGroup(com.xebialabs.xlrelease.domain.group.ReleaseGroup releaseGroup)
void	deleteGroup(java.lang.String groupId)
com.xebialabs.xlrelease.domain.group.ReleaseGroup	getGroup(java.lang.String groupId)
java.util.List<java.lang.String>	getMembers(java.lang.String groupId)
com.xebialabs.xlrelease.api.v1.views.ReleaseGroupTimeline	getReleaseGroupTimeline(java.lang.String groupId)
void	removeMembersFromGroup(java.lang.String groupId, java.util.List<java.lang.String> memberIds)
java.util.List<com.xebialabs.xlrelease.domain.group.ReleaseGroup>	searchGroups(com.xebialabs.xlrelease.api.v1.forms.ReleaseGroupFilters groupFilters, java.lang.Long page, java.lang.Long resultsPerPage, com.xebialabs.xlrelease.api.v1.forms.ReleaseGroupOrderMode orderBy)
default java.lang.String	serviceName()
com.xebialabs.xlrelease.domain.group.ReleaseGroup	updateGroup(java.lang.String groupId, com.xebialabs.xlrelease.domain.group.ReleaseGroup releaseGroup)

Method Detail

serviceName

default java.lang.String serviceName()

Specified by:

serviceName in interface ApiService

getGroup

@GET
@Path("/{groupId:.*ReleaseGroup[^/]*}")
com.xebialabs.xlrelease.domain.group.ReleaseGroup getGroup(@PathParam("groupId")
                                                           java.lang.String groupId)

deleteGroup

@DELETE
@Path("/{groupId:.*ReleaseGroup[^/]*}")
void deleteGroup(@PathParam("groupId")
                 java.lang.String groupId)

createGroup

@POST
com.xebialabs.xlrelease.domain.group.ReleaseGroup createGroup(com.xebialabs.xlrelease.domain.group.ReleaseGroup releaseGroup)

updateGroup

@PUT
@Path("/{groupId:.*ReleaseGroup[^/]*}")
com.xebialabs.xlrelease.domain.group.ReleaseGroup updateGroup(@PathParam("groupId")
                                                              java.lang.String groupId,
                                                              com.xebialabs.xlrelease.domain.group.ReleaseGroup releaseGroup)

getMembers

@GET
@Path("/{groupId:.*ReleaseGroup[^/]*}/members")
java.util.List<java.lang.String> getMembers(@PathParam("groupId")
                                            java.lang.String groupId)

addMembersToGroup

@POST
@Path("/{groupId:.*ReleaseGroup[^/]*}/members")
void addMembersToGroup(@PathParam("groupId")
                       java.lang.String groupId,
                       java.util.List<java.lang.String> memberIds)

removeMembersFromGroup

@DELETE
@Path("/{groupId:.*ReleaseGroup[^/]*}/members")
void removeMembersFromGroup(@PathParam("groupId")
                            java.lang.String groupId,
                            java.util.List<java.lang.String> memberIds)

searchGroups

@POST
@Path("search")
java.util.List<com.xebialabs.xlrelease.domain.group.ReleaseGroup> searchGroups(com.xebialabs.xlrelease.api.v1.forms.ReleaseGroupFilters groupFilters,
                                                                               @DefaultValue("0") @QueryParam("page")
                                                                               java.lang.Long page,
                                                                               @DefaultValue("100") @QueryParam("resultsPerPage")
                                                                               java.lang.Long resultsPerPage,
                                                                               @DefaultValue("RISK") @QueryParam("orderBy")
                                                                               com.xebialabs.xlrelease.api.v1.forms.ReleaseGroupOrderMode orderBy)

getReleaseGroupTimeline

@GET
@Path("/{groupId:.*ReleaseGroup[^/]*}/timeline")
com.xebialabs.xlrelease.api.v1.views.ReleaseGroupTimeline getReleaseGroupTimeline(@PathParam("groupId")
                                                                                  java.lang.String groupId)