Package org.openapitools.client.api

Class ModificationApi

  • public class ModificationApi
extends Object

    • Constructor Detail

      • ModificationApi

        public ModificationApi()

      • ModificationApi

        public ModificationApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • executeModificationCall

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

      • executeModification

        public void executeModification​(ModificationDto modificationDto)
                         throws ApiException
        Execute Modification Executes a modification synchronously for multiple process instances. To modify a single process instance, use the [Modify Process Instance Execution State](https://docs.camunda.org/manual/7.18/reference/rest/process-instance/post-modification/) method. To execute a modification asynchronously, use the [Execute Modification Async (Batch)](https://docs.camunda.org/manual/7.18/reference/rest/modification/post-modification-async/) method. For more information about the difference between synchronous and asynchronous execution of a modification, please refer to the related section of the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
        Parameters:
        modificationDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeModificationWithHttpInfo

        public ApiResponse<Void> executeModificationWithHttpInfo​(ModificationDto modificationDto)
                                                  throws ApiException
        Execute Modification Executes a modification synchronously for multiple process instances. To modify a single process instance, use the [Modify Process Instance Execution State](https://docs.camunda.org/manual/7.18/reference/rest/process-instance/post-modification/) method. To execute a modification asynchronously, use the [Execute Modification Async (Batch)](https://docs.camunda.org/manual/7.18/reference/rest/modification/post-modification-async/) method. For more information about the difference between synchronous and asynchronous execution of a modification, please refer to the related section of the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
        Parameters:
        modificationDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeModificationAsync

        public okhttp3.Call executeModificationAsync​(ModificationDto modificationDto,
                                             ApiCallback<Void> _callback)
                                      throws ApiException
        Execute Modification (asynchronously) Executes a modification synchronously for multiple process instances. To modify a single process instance, use the [Modify Process Instance Execution State](https://docs.camunda.org/manual/7.18/reference/rest/process-instance/post-modification/) method. To execute a modification asynchronously, use the [Execute Modification Async (Batch)](https://docs.camunda.org/manual/7.18/reference/rest/modification/post-modification-async/) method. For more information about the difference between synchronous and asynchronous execution of a modification, please refer to the related section of the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
        Parameters:
        modificationDto - (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

      • executeModificationAsyncCall

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

      • executeModificationAsync

        public BatchDto executeModificationAsync​(ModificationDto modificationDto)
                                  throws ApiException
        Execute Modification Async (Batch) Executes a modification asynchronously for multiple process instances. To execute a modification synchronously, use the [Execute Modification](https://docs.camunda.org/manual/7.18/reference/rest/modification/post-modification-sync/) method. For more information about the difference between synchronous and asynchronous execution of a modification, please refer to the related section of the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
        Parameters:
        modificationDto - (optional)
        Returns:
        BatchDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeModificationAsyncWithHttpInfo

        public ApiResponse<BatchDto> executeModificationAsyncWithHttpInfo​(ModificationDto modificationDto)
                                                           throws ApiException
        Execute Modification Async (Batch) Executes a modification asynchronously for multiple process instances. To execute a modification synchronously, use the [Execute Modification](https://docs.camunda.org/manual/7.18/reference/rest/modification/post-modification-sync/) method. For more information about the difference between synchronous and asynchronous execution of a modification, please refer to the related section of the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
        Parameters:
        modificationDto - (optional)
        Returns:
        ApiResponse<BatchDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • executeModificationAsyncAsync

        public okhttp3.Call executeModificationAsyncAsync​(ModificationDto modificationDto,
                                                  ApiCallback<BatchDto> _callback)
                                           throws ApiException
        Execute Modification Async (Batch) (asynchronously) Executes a modification asynchronously for multiple process instances. To execute a modification synchronously, use the [Execute Modification](https://docs.camunda.org/manual/7.18/reference/rest/modification/post-modification-sync/) method. For more information about the difference between synchronous and asynchronous execution of a modification, please refer to the related section of the [user guide](https://docs.camunda.org/manual/7.18/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
        Parameters:
        modificationDto - (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