Package org.openapitools.client.api

Class GroupApi

  • public class GroupApi
extends Object

    • Constructor Detail

      • GroupApi

        public GroupApi()

      • GroupApi

        public GroupApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • availableGroupInstanceOperationsCall

        public okhttp3.Call availableGroupInstanceOperationsCall​(String id,
                                                         ApiCallback _callback)
                                                  throws ApiException
        Build call for availableGroupInstanceOperations
        Parameters:
        id - The id of the group. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • availableGroupInstanceOperationsWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableGroupInstanceOperationsWithHttpInfo​(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:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableGroupInstanceOperationsAsync

        public okhttp3.Call availableGroupInstanceOperationsAsync​(String id,
                                                          ApiCallback<ResourceOptionsDto> _callback)
                                                   throws ApiException
        Group Resource Instance Options (asynchronously) 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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • availableGroupMembersOperationsCall

        public okhttp3.Call availableGroupMembersOperationsCall​(String id,
                                                        ApiCallback _callback)
                                                 throws ApiException
        Build call for availableGroupMembersOperations
        Parameters:
        id - The id of the group. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • availableGroupMembersOperationsWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableGroupMembersOperationsWithHttpInfo​(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:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableGroupMembersOperationsAsync

        public okhttp3.Call availableGroupMembersOperationsAsync​(String id,
                                                         ApiCallback<ResourceOptionsDto> _callback)
                                                  throws ApiException
        Group Membership Resource Options (asynchronously) 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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • availableGroupOperationsCall

        public okhttp3.Call availableGroupOperationsCall​(ApiCallback _callback)
                                          throws ApiException
        Build call for availableGroupOperations
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • availableGroupOperationsWithHttpInfo

        public ApiResponse<ResourceOptionsDto> availableGroupOperationsWithHttpInfo()
                                                                     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:
        ApiResponse<ResourceOptionsDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • availableGroupOperationsAsync

        public okhttp3.Call availableGroupOperationsAsync​(ApiCallback<ResourceOptionsDto> _callback)
                                           throws ApiException
        Group Resource Options (asynchronously) 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:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • createGroupCall

        public okhttp3.Call createGroupCall​(GroupDto groupDto,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for createGroup
        Parameters:
        groupDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createGroup

        public void createGroup​(GroupDto groupDto)
                 throws ApiException
        Create Group Creates a new group.
        Parameters:
        groupDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createGroupWithHttpInfo

        public ApiResponse<Void> createGroupWithHttpInfo​(GroupDto groupDto)
                                          throws ApiException
        Create Group Creates a new group.
        Parameters:
        groupDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createGroupAsync

        public okhttp3.Call createGroupAsync​(GroupDto groupDto,
                                     ApiCallback<Void> _callback)
                              throws ApiException
        Create Group (asynchronously) Creates a new group.
        Parameters:
        groupDto - (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • createGroupMemberCall

        public okhttp3.Call createGroupMemberCall​(String id,
                                          String userId,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for createGroupMember
        Parameters:
        id - The id of the group. (required)
        userId - The id of user to add to the group. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • createGroupMemberWithHttpInfo

        public ApiResponse<Void> createGroupMemberWithHttpInfo​(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)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createGroupMemberAsync

        public okhttp3.Call createGroupMemberAsync​(String id,
                                           String userId,
                                           ApiCallback<Void> _callback)
                                    throws ApiException
        Create Group Member (asynchronously) 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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • deleteGroupCall

        public okhttp3.Call deleteGroupCall​(String id,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for deleteGroup
        Parameters:
        id - The id of the group to be deleted. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteGroupWithHttpInfo

        public ApiResponse<Void> deleteGroupWithHttpInfo​(String id)
                                          throws ApiException
        Delete Group Deletes a group by id.
        Parameters:
        id - The id of the group to be deleted. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteGroupAsync

        public okhttp3.Call deleteGroupAsync​(String id,
                                     ApiCallback<Void> _callback)
                              throws ApiException
        Delete Group (asynchronously) Deletes a group by id.
        Parameters:
        id - The id of the group to be deleted. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • deleteGroupMemberCall

        public okhttp3.Call deleteGroupMemberCall​(String id,
                                          String userId,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for deleteGroupMember
        Parameters:
        id - The id of the group. (required)
        userId - The id of user to remove from the group. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteGroupMemberWithHttpInfo

        public ApiResponse<Void> deleteGroupMemberWithHttpInfo​(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)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • deleteGroupMemberAsync

        public okhttp3.Call deleteGroupMemberAsync​(String id,
                                           String userId,
                                           ApiCallback<Void> _callback)
                                    throws ApiException
        Delete a Group Member (asynchronously) 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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getGroupCall

        public okhttp3.Call getGroupCall​(String id,
                                 ApiCallback _callback)
                          throws ApiException
        Build call for getGroup
        Parameters:
        id - The id of the group to be retrieved. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getGroupWithHttpInfo

        public ApiResponse<GroupDto> getGroupWithHttpInfo​(String id)
                                           throws ApiException
        Get Group Retrieves a group by id.
        Parameters:
        id - The id of the group to be retrieved. (required)
        Returns:
        ApiResponse<GroupDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getGroupAsync

        public okhttp3.Call getGroupAsync​(String id,
                                  ApiCallback<GroupDto> _callback)
                           throws ApiException
        Get Group (asynchronously) Retrieves a group by id.
        Parameters:
        id - The id of the group to be retrieved. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getGroupCountCall

        public okhttp3.Call getGroupCountCall​(String id,
                                      String idIn,
                                      String name,
                                      String nameLike,
                                      String type,
                                      String member,
                                      String memberOfTenant,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getGroupCount
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getGroupCountWithHttpInfo

        public ApiResponse<CountResultDto> getGroupCountWithHttpInfo​(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:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getGroupCountAsync

        public okhttp3.Call getGroupCountAsync​(String id,
                                       String idIn,
                                       String name,
                                       String nameLike,
                                       String type,
                                       String member,
                                       String memberOfTenant,
                                       ApiCallback<CountResultDto> _callback)
                                throws ApiException
        Get List Count (asynchronously) 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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • getQueryGroupsCall

        public okhttp3.Call getQueryGroupsCall​(String sortBy,
                                       String sortOrder,
                                       Integer firstResult,
                                       Integer maxResults,
                                       String id,
                                       String idIn,
                                       String name,
                                       String nameLike,
                                       String type,
                                       String member,
                                       String memberOfTenant,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for getQueryGroups
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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 fail to call the API, e.g. server error or cannot deserialize the response body

      • getQueryGroupsWithHttpInfo

        public ApiResponse<List<GroupDto>> getQueryGroupsWithHttpInfo​(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.18/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:
        ApiResponse<List<GroupDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getQueryGroupsAsync

        public okhttp3.Call getQueryGroupsAsync​(String sortBy,
                                        String sortOrder,
                                        Integer firstResult,
                                        Integer maxResults,
                                        String id,
                                        String idIn,
                                        String name,
                                        String nameLike,
                                        String type,
                                        String member,
                                        String memberOfTenant,
                                        ApiCallback<List<GroupDto>> _callback)
                                 throws ApiException
        Get List (asynchronously) 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.18/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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • postQueryGroupsCall

        public okhttp3.Call postQueryGroupsCall​(Integer firstResult,
                                        Integer maxResults,
                                        GroupQueryDto groupQueryDto,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for postQueryGroups
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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.18/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 fail to call the API, e.g. server error or cannot deserialize the response body

      • postQueryGroupsWithHttpInfo

        public ApiResponse<List<GroupDto>> postQueryGroupsWithHttpInfo​(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.18/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:
        ApiResponse<List<GroupDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • postQueryGroupsAsync

        public okhttp3.Call postQueryGroupsAsync​(Integer firstResult,
                                         Integer maxResults,
                                         GroupQueryDto groupQueryDto,
                                         ApiCallback<List<GroupDto>> _callback)
                                  throws ApiException
        Get List (POST) (asynchronously) 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.18/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)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • queryGroupCountCall

        public okhttp3.Call queryGroupCountCall​(GroupQueryDto groupQueryDto,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for queryGroupCount
        Parameters:
        groupQueryDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • queryGroupCountWithHttpInfo

        public ApiResponse<CountResultDto> queryGroupCountWithHttpInfo​(GroupQueryDto groupQueryDto)
                                                        throws ApiException
        Get List Count (POST) Queries for groups using a list of parameters and retrieves the count.
        Parameters:
        groupQueryDto - (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryGroupCountAsync

        public okhttp3.Call queryGroupCountAsync​(GroupQueryDto groupQueryDto,
                                         ApiCallback<CountResultDto> _callback)
                                  throws ApiException
        Get List Count (POST) (asynchronously) Queries for groups using a list of parameters and retrieves the count.
        Parameters:
        groupQueryDto - (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object

      • updateGroupCall

        public okhttp3.Call updateGroupCall​(String id,
                                    GroupDto groupDto,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for updateGroup
        Parameters:
        id - The id of the group. (required)
        groupDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • 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 fail to call the API, e.g. server error or cannot deserialize the response body

      • updateGroupWithHttpInfo

        public ApiResponse<Void> updateGroupWithHttpInfo​(String id,
                                                 GroupDto groupDto)
                                          throws ApiException
        Update Group Updates a given group by id.
        Parameters:
        id - The id of the group. (required)
        groupDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • updateGroupAsync

        public okhttp3.Call updateGroupAsync​(String id,
                                     GroupDto groupDto,
                                     ApiCallback<Void> _callback)
                              throws ApiException
        Update Group (asynchronously) Updates a given group by id.
        Parameters:
        id - The id of the group. (required)
        groupDto - (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object