@Path(value="/group")
public interface GroupResource
Modifier and Type | Method and Description |
---|---|
GroupLoadResponse |
add(String id,
Group group)
Create subgroup
|
UserLoadResponse |
addUser(String id,
String userId)
Add existing user to the given group
|
UserLoadResponse |
createUser(String id,
User user)
Create user in the given group
|
javax.ws.rs.core.Response |
delete(String id)
Delete a group
|
GroupLoadResponse |
get(String id)
Load group with given ID
|
GroupList |
list(FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
List groups
|
GroupsResponse |
list(Integer skipCount,
Integer maxItems,
List<Integer> ids,
List<String> names,
List<String> memberLogins,
List<Integer> memberIds,
List<Integer> childGroupIds,
List<Integer> privFolderIds,
List<Privilege> privileges,
GroupReduceType reduce,
GroupSortAttribute sortBy,
SortOrder sortOrder)
Get a list of groups, optionally filtered sorted and paged.
|
GroupsResponse |
load()
Load the groups the user may see
|
GroupLoadResponse |
move(String id,
String subgroupId)
Move subgroup
|
javax.ws.rs.core.Response |
removeUser(String id,
String userId)
Remove user from a group
|
GroupList |
subgroups(String id,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
List subgroups of the given group
|
GroupLoadResponse |
update(String id,
Group group)
Update a group
|
UserList |
users(String id,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
List users of given group
|
@GET @Path(value="/load") GroupsResponse load()
@GET @Path(value="/list") GroupsResponse list(@QueryParam(value="skipCount") @DefaultValue(value="0") Integer skipCount, @QueryParam(value="maxItems") @DefaultValue(value="-1") Integer maxItems, @QueryParam(value="id") List<Integer> ids, @QueryParam(value="name") List<String> names, @QueryParam(value="memberlogin") List<String> memberLogins, @QueryParam(value="memberid") List<Integer> memberIds, @QueryParam(value="children") List<Integer> childGroupIds, @QueryParam(value="folder") List<Integer> privFolderIds, @QueryParam(value="privileges") List<Privilege> privileges, @QueryParam(value="reduce") GroupReduceType reduce, @QueryParam(value="sortby") GroupSortAttribute sortBy, @QueryParam(value="sortorder") @DefaultValue(value="asc") SortOrder sortOrder)
skipCount
- number of groups skipped in the list (paging)maxItems
- maximum number of groups returned (paging)ids
- id of the group to return (filter)names
- name or name pattern of the group(s) to return (filter)memberLogins
- login name of the group member for the group(s) to return (filter)memberIds
- id of the group member for the group(s) to return (filter)children
- ids of child groups for the group(s) to return (filter)sortBy
- name of the sorted attribute (sorting)sortOrder
- sortorder (sorting)@GET GroupList list(@BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
filter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@GET @Path(value="/{id}") GroupLoadResponse get(@PathParam(value="id") String id) throws Exception
id
- local group IDException
@GET @Path(value="/{id}/groups") GroupList subgroups(@PathParam(value="id") String id, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
id
- local group IDfilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@PUT @Path(value="/{id}/groups") GroupLoadResponse add(@PathParam(value="id") String id, Group group) throws Exception
id
- local group IDgroup
- groupException
@PUT @Path(value="/{id}/groups/{subgroupId}") GroupLoadResponse move(@PathParam(value="id") String id, @PathParam(value="subgroupId") String subgroupId) throws Exception
id
- local mother group IDgroup
- groupException
@DELETE @Path(value="/{id}") javax.ws.rs.core.Response delete(@PathParam(value="id") String id) throws Exception
id
- local group IDException
@POST @Path(value="/{id}") GroupLoadResponse update(@PathParam(value="id") String id, Group group) throws Exception
id
- local group IDgroup
- new group dataException
@GET @Path(value="/{id}/users") UserList users(@PathParam(value="id") String id, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
id
- local group IDfilter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@PUT @Path(value="/{id}/users") UserLoadResponse createUser(@PathParam(value="id") String id, User user) throws Exception
id
- local group IDuser
- user to createException
@PUT @Path(value="/{id}/users/{userId}") UserLoadResponse addUser(@PathParam(value="id") String id, @PathParam(value="userId") String userId) throws Exception
id
- local group IDuserId
- local user IDException
@DELETE @Path(value="/{id}/users/{userId}") javax.ws.rs.core.Response removeUser(@PathParam(value="id") String id, @PathParam(value="userId") String userId) throws Exception
id
- local group IDuserId
- local user IDException
Copyright © 2019 Gentics Software. All rights reserved.