Package org.camunda.community.rest.client.api

Class GroupApi

java.lang.Object
org.camunda.community.rest.client.api.GroupApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-04T13:43:01.451833574Z[Etc/UTC]") public class GroupApi extends Object

  • Constructor Details

    • GroupApi

      public GroupApi()

    • GroupApi

      public GroupApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • availableGroupInstanceOperations

      public ResourceOptionsDto availableGroupInstanceOperations(String id) throws ApiException
      Group Resource Instance Options The `/group` resource supports two custom OPTIONS requests, one for the resource as such and this one for individual group instances. The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the `/group/{id}` resource instance. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the group. (required)
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableGroupInstanceOperations

      public ResourceOptionsDto availableGroupInstanceOperations(String id, Map<String,String> additionalHeaders) throws ApiException
      Group Resource Instance Options The `/group` resource supports two custom OPTIONS requests, one for the resource as such and this one for individual group instances. The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the `/group/{id}` resource instance. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the group. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableGroupMembersOperations

      public ResourceOptionsDto availableGroupMembersOperations(String id) throws ApiException
      Group Membership Resource Options The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the group. (required)
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableGroupMembersOperations

      public ResourceOptionsDto availableGroupMembersOperations(String id, Map<String,String> additionalHeaders) throws ApiException
      Group Membership Resource Options The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      id - The id of the group. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableGroupOperations

      public ResourceOptionsDto availableGroupOperations() throws ApiException
      Group Resource Options The `/group` resource supports two custom OPTIONS requests, this one for the resource as such and one for individual group instances. The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the `/group` resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • availableGroupOperations

      public ResourceOptionsDto availableGroupOperations(Map<String,String> additionalHeaders) throws ApiException
      Group Resource Options The `/group` resource supports two custom OPTIONS requests, this one for the resource as such and one for individual group instances. The OPTIONS request allows checking for the set of available operations that the currently authenticated user can perform on the `/group` resource. If the user can perform an operation or not may depend on various things, including the users authorizations to interact with this resource and the internal configuration of the process engine.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      ResourceOptionsDto
      Throws:
      ApiException - if fails to make API call

    • createGroup

      public void createGroup(GroupDto groupDto) throws ApiException
      Create Group Creates a new group.
      Parameters:
      groupDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • createGroup

      public void createGroup(GroupDto groupDto, Map<String,String> additionalHeaders) throws ApiException
      Create Group Creates a new group.
      Parameters:
      groupDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • createGroupMember

      public void createGroupMember(String id, String userId) throws ApiException
      Create Group Member Adds a member to a group.
      Parameters:
      id - The id of the group. (required)
      userId - The id of user to add to the group. (required)
      Throws:
      ApiException - if fails to make API call

    • createGroupMember

      public void createGroupMember(String id, String userId, Map<String,String> additionalHeaders) throws ApiException
      Create Group Member Adds a member to a group.
      Parameters:
      id - The id of the group. (required)
      userId - The id of user to add to the group. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteGroup

      public void deleteGroup(String id) throws ApiException
      Delete Group Deletes a group by id.
      Parameters:
      id - The id of the group to be deleted. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteGroup

      public void deleteGroup(String id, Map<String,String> additionalHeaders) throws ApiException
      Delete Group Deletes a group by id.
      Parameters:
      id - The id of the group to be deleted. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteGroupMember

      public void deleteGroupMember(String id, String userId) throws ApiException
      Delete a Group Member Removes a member from a group.
      Parameters:
      id - The id of the group. (required)
      userId - The id of user to remove from the group. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteGroupMember

      public void deleteGroupMember(String id, String userId, Map<String,String> additionalHeaders) throws ApiException
      Delete a Group Member Removes a member from a group.
      Parameters:
      id - The id of the group. (required)
      userId - The id of user to remove from the group. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getGroup

      public GroupDto getGroup(String id) throws ApiException
      Get Group Retrieves a group by id.
      Parameters:
      id - The id of the group to be retrieved. (required)
      Returns:
      GroupDto
      Throws:
      ApiException - if fails to make API call

    • getGroup

      public GroupDto getGroup(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Group Retrieves a group by id.
      Parameters:
      id - The id of the group to be retrieved. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GroupDto
      Throws:
      ApiException - if fails to make API call

    • getGroupCount

      public CountResultDto getGroupCount(String id, String idIn, String name, String nameLike, String type, String member, String memberOfTenant) throws ApiException
      Get List Count Queries for groups using a list of parameters and retrieves the count.
      Parameters:
      id - Filter by the id of the group. (optional)
      idIn - Filter by a comma seperated list of group ids. (optional)
      name - Filter by the name of the group. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      type - Filter by the type of the group. (optional)
      member - Only retrieve groups where the given user id is a member of. (optional)
      memberOfTenant - Only retrieve groups which are members of the given tenant. (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getGroupCount

      public CountResultDto getGroupCount(String id, String idIn, String name, String nameLike, String type, String member, String memberOfTenant, Map<String,String> additionalHeaders) throws ApiException
      Get List Count Queries for groups using a list of parameters and retrieves the count.
      Parameters:
      id - Filter by the id of the group. (optional)
      idIn - Filter by a comma seperated list of group ids. (optional)
      name - Filter by the name of the group. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      type - Filter by the type of the group. (optional)
      member - Only retrieve groups where the given user id is a member of. (optional)
      memberOfTenant - Only retrieve groups which are members of the given tenant. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • getQueryGroups

      public List<GroupDto> getQueryGroups(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String id, String idIn, String name, String nameLike, String type, String member, String memberOfTenant) throws ApiException
      Get List Queries for a list of groups using a list of parameters. The size of the result set can be retrieved by using the [Get Group Count](https://docs.camunda.org/manual/7.21/reference/rest/group/get-query-count) method.
      Parameters:
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      id - Filter by the id of the group. (optional)
      idIn - Filter by a comma seperated list of group ids. (optional)
      name - Filter by the name of the group. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      type - Filter by the type of the group. (optional)
      member - Only retrieve groups where the given user id is a member of. (optional)
      memberOfTenant - Only retrieve groups which are members of the given tenant. (optional)
      Returns:
      List<GroupDto>
      Throws:
      ApiException - if fails to make API call

    • getQueryGroups

      public List<GroupDto> getQueryGroups(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String id, String idIn, String name, String nameLike, String type, String member, String memberOfTenant, Map<String,String> additionalHeaders) throws ApiException
      Get List Queries for a list of groups using a list of parameters. The size of the result set can be retrieved by using the [Get Group Count](https://docs.camunda.org/manual/7.21/reference/rest/group/get-query-count) method.
      Parameters:
      sortBy - Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter. (optional)
      sortOrder - Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter. (optional)
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      id - Filter by the id of the group. (optional)
      idIn - Filter by a comma seperated list of group ids. (optional)
      name - Filter by the name of the group. (optional)
      nameLike - Filter by the name that the parameter is a substring of. (optional)
      type - Filter by the type of the group. (optional)
      member - Only retrieve groups where the given user id is a member of. (optional)
      memberOfTenant - Only retrieve groups which are members of the given tenant. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<GroupDto>
      Throws:
      ApiException - if fails to make API call

    • postQueryGroups

      public List<GroupDto> postQueryGroups(Integer firstResult, Integer maxResults, GroupQueryDto groupQueryDto) throws ApiException
      Get List (POST) Queries for a list of groups using a list of parameters. The size of the result set can be retrieved by using the [Get Group Count (POST)](https://docs.camunda.org/manual/7.21/reference/rest/group/post-query-count/) method.
      Parameters:
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      groupQueryDto - (optional)
      Returns:
      List<GroupDto>
      Throws:
      ApiException - if fails to make API call

    • postQueryGroups

      public List<GroupDto> postQueryGroups(Integer firstResult, Integer maxResults, GroupQueryDto groupQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get List (POST) Queries for a list of groups using a list of parameters. The size of the result set can be retrieved by using the [Get Group Count (POST)](https://docs.camunda.org/manual/7.21/reference/rest/group/post-query-count/) method.
      Parameters:
      firstResult - Pagination of results. Specifies the index of the first result to return. (optional)
      maxResults - Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. (optional)
      groupQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<GroupDto>
      Throws:
      ApiException - if fails to make API call

    • queryGroupCount

      public CountResultDto queryGroupCount(GroupQueryDto groupQueryDto) throws ApiException
      Get List Count (POST) Queries for groups using a list of parameters and retrieves the count.
      Parameters:
      groupQueryDto - (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • queryGroupCount

      public CountResultDto queryGroupCount(GroupQueryDto groupQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get List Count (POST) Queries for groups using a list of parameters and retrieves the count.
      Parameters:
      groupQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • updateGroup

      public void updateGroup(String id, GroupDto groupDto) throws ApiException
      Update Group Updates a given group by id.
      Parameters:
      id - The id of the group. (required)
      groupDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • updateGroup

      public void updateGroup(String id, GroupDto groupDto, Map<String,String> additionalHeaders) throws ApiException
      Update Group Updates a given group by id.
      Parameters:
      id - The id of the group. (required)
      groupDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call