Package com.atlassian.confluence.plugins.restapi.experimental.resources

Class ExperimentalGroupResource

java.lang.Object

com.atlassian.confluence.plugins.restapi.experimental.resources.ExperimentalGroupResource

@ExperimentalApi
@Consumes("application/json")
@Produces("application/json")
@Path("/group")
public class ExperimentalGroupResource
extends Object

Non-admin operations for user groups Experimental Group Resource, delete this once GroupResource is published

Constructor Summary

Constructors

Constructor	Description
ExperimentalGroupResource(GroupService groupService, PersonService personService)

Method Summary

Modifier and Type	Method	Description
Group	getGroup(String groupName, String expand)	Get the user group with the group name
PageResponse<Group>	getGroups(String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)	Get a paginated collection of user groups
PageResponse<Person>	getMembers(Group group, String expand, int start, int limit, jakarta.ws.rs.core.UriInfo uriInfo)	Get a paginated collection of users in the given group

Methods inherited from class java.lang.Object

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

Constructor Details

ExperimentalGroupResource

@Inject
public ExperimentalGroupResource(GroupService groupService,
 PersonService personService)

Method Details

getGroups

@GET
public PageResponse<Group> getGroups(@QueryParam("expand") @DefaultValue("")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Get a paginated collection of user groups

Parameters:

start - the start point of the collection to return

limit - the limit of the number of items to return, this may be restricted by fixed system limits

Returns:

a paginated collection of user groups

getGroup

@GET
@Path("{groupName}")
public Group getGroup(@PathParam("groupName")
 String groupName,
 @QueryParam("expand")
 String expand)

Get the user group with the group name

Parameters:

groupName -

Returns:

the user group with the group name

getMembers

@GET
@Path("{groupName}/member")
public PageResponse<Person> getMembers(@PathParam("groupName")
 Group group,
 @QueryParam("expand")
 String expand,
 @QueryParam("start")
 int start,
 @QueryParam("limit") @DefaultValue("200")
 int limit,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Get a paginated collection of users in the given group

Parameters:

group - the group to look up the members for

start - the start point of the collection to return

limit - the limit of the number of items to return, this may be restricted by fixed system limits

Returns:

a collection of users in the given group