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 TypeMethodDescriptionvoid
addMembersToGroup
(String groupId, List<String> memberIds) createGroup
(ReleaseGroup releaseGroup) void
deleteGroup
(String groupId) getMembers
(String groupId) getReleaseGroupTimeline
(String groupId) void
removeMembersFromGroup
(String groupId, List<String> memberIds) searchGroups
(ReleaseGroupFilters groupFilters, Long page, Long resultsPerPage, ReleaseGroupOrderMode orderBy) default String
updateGroup
(String groupId, ReleaseGroup releaseGroup)
-
Method Details
-
serviceName
- Specified by:
serviceName
in interfaceApiService
-
getGroup
@GET @Path("/{groupId:.*ReleaseGroup[^/]*}") ReleaseGroup getGroup(@PathParam("groupId") String groupId) -
deleteGroup
@DELETE @Path("/{groupId:.*ReleaseGroup[^/]*}") void deleteGroup(@PathParam("groupId") String groupId) -
createGroup
-
updateGroup
@PUT @Path("/{groupId:.*ReleaseGroup[^/]*}") ReleaseGroup updateGroup(@PathParam("groupId") String groupId, ReleaseGroup releaseGroup) -
getMembers
-
addMembersToGroup
-
removeMembersFromGroup
-
searchGroups
@POST @Path("search") List<ReleaseGroup> searchGroups(ReleaseGroupFilters groupFilters, @DefaultValue("0") @QueryParam("page") Long page, @DefaultValue("100") @QueryParam("resultsPerPage") Long resultsPerPage, @DefaultValue("RISK") @QueryParam("orderBy") ReleaseGroupOrderMode orderBy) -
getReleaseGroupTimeline
@GET @Path("/{groupId:.*ReleaseGroup[^/]*}/timeline") ReleaseGroupTimeline getReleaseGroupTimeline(@PathParam("groupId") String groupId)
-