@Path(value="/group") public interface GroupResource extends AuthenticatedResource
Modifier and Type | Method and Description |
---|---|
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
|
setSessionId
@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)Copyright © 2017 Gentics Software. All rights reserved.