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

Class ModificationApi

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

  • Constructor Details

    • ModificationApi

      public ModificationApi()

    • ModificationApi

      public ModificationApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • 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.21/reference/rest/process-instance/post-modification/) method. To execute a modification asynchronously, use the [Execute Modification Async (Batch)](https://docs.camunda.org/manual/7.21/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.21/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
      Parameters:
      modificationDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • executeModification

      public void executeModification(ModificationDto modificationDto, Map<String,String> additionalHeaders) 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.21/reference/rest/process-instance/post-modification/) method. To execute a modification asynchronously, use the [Execute Modification Async (Batch)](https://docs.camunda.org/manual/7.21/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.21/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
      Parameters:
      modificationDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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.21/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.21/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
      Parameters:
      modificationDto - (optional)
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • executeModificationAsync

      public BatchDto executeModificationAsync(ModificationDto modificationDto, Map<String,String> additionalHeaders) 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.21/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.21/user-guide/process-engine/process-instance-migration.md#executing-a-migration-plan).
      Parameters:
      modificationDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call