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

Class MigrationApi

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

  • Constructor Details

    • MigrationApi

      public MigrationApi()

    • MigrationApi

      public MigrationApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • executeMigrationPlan

      public void executeMigrationPlan(MigrationExecutionDto migrationExecutionDto) throws ApiException
      Execute Migration Plan Executes a migration plan synchronously for multiple process instances. To execute a migration plan asynchronously, use the [Execute Migration Plan Async(Batch)](https://docs.camunda.org/manual/7.21/reference/rest/migration/execute-migration-async/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
      Parameters:
      migrationExecutionDto - (optional)
      Throws:
      ApiException - if fails to make API call

    • executeMigrationPlan

      public void executeMigrationPlan(MigrationExecutionDto migrationExecutionDto, Map<String,String> additionalHeaders) throws ApiException
      Execute Migration Plan Executes a migration plan synchronously for multiple process instances. To execute a migration plan asynchronously, use the [Execute Migration Plan Async(Batch)](https://docs.camunda.org/manual/7.21/reference/rest/migration/execute-migration-async/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
      Parameters:
      migrationExecutionDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • executeMigrationPlanAsync

      public BatchDto executeMigrationPlanAsync(MigrationExecutionDto migrationExecutionDto) throws ApiException
      Execute Migration Plan Async (Batch) Executes a migration plan asynchronously (batch) for multiple process instances. To execute a migration plan synchronously, use the [Execute MigrationPlan](https://docs.camunda.org/manual/7.21/reference/rest/migration/execute-migration/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
      Parameters:
      migrationExecutionDto - (optional)
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • executeMigrationPlanAsync

      public BatchDto executeMigrationPlanAsync(MigrationExecutionDto migrationExecutionDto, Map<String,String> additionalHeaders) throws ApiException
      Execute Migration Plan Async (Batch) Executes a migration plan asynchronously (batch) for multiple process instances. To execute a migration plan synchronously, use the [Execute MigrationPlan](https://docs.camunda.org/manual/7.21/reference/rest/migration/execute-migration/) method. For more information about the difference between synchronous and asynchronous execution of a migration plan, please refer to the related section of [the user guide](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-migration/#executing-a-migration-plan).
      Parameters:
      migrationExecutionDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • generateMigrationPlan

      public MigrationPlanDto generateMigrationPlan(MigrationPlanGenerationDto migrationPlanGenerationDto) throws ApiException
      Generate Migration Plan Generates a migration plan for two process definitions. The generated migration plan contains migration instructions which map equal activities between the two process definitions.
      Parameters:
      migrationPlanGenerationDto - (optional)
      Returns:
      MigrationPlanDto
      Throws:
      ApiException - if fails to make API call

    • generateMigrationPlan

      public MigrationPlanDto generateMigrationPlan(MigrationPlanGenerationDto migrationPlanGenerationDto, Map<String,String> additionalHeaders) throws ApiException
      Generate Migration Plan Generates a migration plan for two process definitions. The generated migration plan contains migration instructions which map equal activities between the two process definitions.
      Parameters:
      migrationPlanGenerationDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      MigrationPlanDto
      Throws:
      ApiException - if fails to make API call

    • validateMigrationPlan

      public MigrationPlanReportDto validateMigrationPlan(MigrationPlanDto migrationPlanDto) throws ApiException
      Validate Migration Plan Validates a migration plan statically without executing it. This corresponds to the [creation time validation](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-migration/#creation-time-validation) described in the user guide.
      Parameters:
      migrationPlanDto - (optional)
      Returns:
      MigrationPlanReportDto
      Throws:
      ApiException - if fails to make API call

    • validateMigrationPlan

      public MigrationPlanReportDto validateMigrationPlan(MigrationPlanDto migrationPlanDto, Map<String,String> additionalHeaders) throws ApiException
      Validate Migration Plan Validates a migration plan statically without executing it. This corresponds to the [creation time validation](https://docs.camunda.org/manual/7.21/user-guide/process-engine/process-instance-migration/#creation-time-validation) described in the user guide.
      Parameters:
      migrationPlanDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      MigrationPlanReportDto
      Throws:
      ApiException - if fails to make API call