Package org.bonitasoft.web.client.api

Interface GroupApi

All Superinterfaces:
ApiClient.Api
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.12.0") public interface GroupApi extends ApiClient.Api

  • Method Details

    • createGroup

      Group createGroup(GroupCreateRequest body)
      Create the Group Create the Group
      Parameters:
      body - Partial Group description (required)
      Returns:
      Group

    • createGroupWithHttpInfo

      ApiResponse<Group> createGroupWithHttpInfo(GroupCreateRequest body)
      Create the Group Similar to createGroup but it also returns the http response headers . Create the Group
      Parameters:
      body - Partial Group description (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • 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)

    • deleteGroupByIdWithHttpInfo

      ApiResponse<Void> deleteGroupByIdWithHttpInfo(String id)
      Delete the Group by ID Similar to deleteGroupById but it also returns the http response headers . 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

    • getGroupByIdWithHttpInfo

      ApiResponse<Group> getGroupByIdWithHttpInfo(String id)
      Finds the Group by ID Similar to getGroupById but it also returns the http response headers . Returns the single Group for the given ID
      Parameters:
      id - ID of the Group to return (required)
      Returns:
      A ApiResponse that wraps the response boyd and the http headers.

    • 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>

    • searchGroupsWithHttpInfo

      ApiResponse<List<Group>> searchGroupsWithHttpInfo(Integer p, Integer c, List<String> f, String o)
      Finds Groups Similar to searchGroups but it also returns the http response headers . 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:
      A ApiResponse that wraps the response boyd and the http headers.

    • searchGroups

      List<Group> searchGroups(GroupApi.SearchGroupsQueryParams 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>

    • searchGroupsWithHttpInfo

      ApiResponse<List<Group>> searchGroupsWithHttpInfo(GroupApi.SearchGroupsQueryParams 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 that receives the query parameters as a map, but this one also exposes the Http response headers
      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)

    • updateGroupByIdWithHttpInfo

      ApiResponse<Void> updateGroupByIdWithHttpInfo(String id, GroupUpdateRequest groupUpdateRequest)
      Update the Group by ID Similar to updateGroupById but it also returns the http response headers . Update the Group for the given ID
      Parameters:
      id - ID of the Group to return (required)
      groupUpdateRequest - Partial Group description (required)