Package org.bonitasoft.web.client.api

Interface GroupApi

All Superinterfaces:

ApiClient.Api

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public interface GroupApi
extends ApiClient.Api

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GroupApi.SearchGroupsQueryParams	A convenience class for generating query parameters for the searchGroups method in a fluent style.

Method Summary

Modifier and Type	Method	Description
Group	createGroup(GroupCreateRequest body)	Create the Group Create the Group
void	deleteGroupById(String id)	Delete the Group by ID Delete the single Group for the given ID
Group	getGroupById(String id)	Finds the Group by ID Returns the single Group for the given ID
List<Group>	searchGroups(Integer p, Integer c, List<String> f, String o)	Finds Groups Finds Groups with pagination params and filters.
List<Group>	searchGroups(Map<String,Object> queryParams)	Finds Groups Finds Groups with pagination params and filters.
void	updateGroupById(String id, GroupUpdateRequest groupUpdateRequest)	Update the Group by ID Update the Group for the given ID

Method Detail

createGroup

Group createGroup(GroupCreateRequest body)

Create the Group Create the Group

Parameters:

body - Partial Group description (required)

Returns:

Group

deleteGroupById

void deleteGroupById(String id)

Delete the Group by ID Delete the single Group for the given ID

Parameters:

id - ID of the Group to delete (required)

getGroupById

Group getGroupById(String id)

Finds the Group by ID Returns the single Group for the given ID

Parameters:

id - ID of the Group to return (required)

Returns:

Group

searchGroups

List<Group> searchGroups(Integer p,
                         Integer c,
                         List<String> f,
                         String o)

Finds Groups Finds Groups with pagination params and filters. - can order on `id`,`name`,`displayName` - can filter on `name`,`displayName`,`parent_path`

Parameters:

p - index of the page to display (required)

c - maximum number of elements to retrieve (required)

f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)

o - can order on attributes (optional)

Returns:

List<Group>

searchGroups

List<Group> searchGroups(Map<String,Object> queryParams)

Finds Groups Finds Groups with pagination params and filters. - can order on `id`,`name`,`displayName` - can filter on `name`,`displayName`,`parent_path` Note, this is equivalent to the other searchGroups method, but with the query parameters collected into a single Map parameter. This is convenient for services with optional query parameters, especially when used with the GroupApi.SearchGroupsQueryParams class that allows for building up this map in a fluent style.

Parameters:

queryParams - Map of query parameters as name-value pairs

The following elements may be specified in the query map:

• p - index of the page to display (required)
• c - maximum number of elements to retrieve (required)
• f - can filter on attributes with the format f={filter\\_name}={filter\\_value} with the name/value pair as url encoded string. (optional)
• o - can order on attributes (optional)

Returns:

List<Group>

updateGroupById

void updateGroupById(String id,
                     GroupUpdateRequest groupUpdateRequest)

Update the Group by ID Update the Group for the given ID

Parameters:

id - ID of the Group to return (required)

groupUpdateRequest - Partial Group description (required)