ProcessInstanceApi (Camunda BPM Javadocs 7.13.18-ee)

java.lang.Object
- org.openapitools.client.api.ProcessInstanceApi

public class ProcessInstanceApi
extends Object

Constructor Summary

Constructors
Constructor and Description

ProcessInstanceApi()

ProcessInstanceApi(ApiClient apiClient)

Constructors
Constructor and Description
`ProcessInstanceApi()`
`ProcessInstanceApi(ApiClient apiClient)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchDto`	`deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto deleteProcessInstancesDto)` Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
`okhttp3.Call`	`deleteAsyncHistoricQueryBasedAsync(DeleteProcessInstancesDto deleteProcessInstancesDto, ApiCallback<BatchDto> _callback)` (asynchronously) Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
`okhttp3.Call`	`deleteAsyncHistoricQueryBasedCall(DeleteProcessInstancesDto deleteProcessInstancesDto, ApiCallback _callback)` Build call for deleteAsyncHistoricQueryBased
`ApiResponse<BatchDto>`	`deleteAsyncHistoricQueryBasedWithHttpInfo(DeleteProcessInstancesDto deleteProcessInstancesDto)` Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
`void`	`deleteProcessInstance(String id, Boolean skipCustomListeners, Boolean skipIoMappings, Boolean skipSubprocesses, Boolean failIfNotExists)` Deletes a running process instance by id.
`okhttp3.Call`	`deleteProcessInstanceAsync(String id, Boolean skipCustomListeners, Boolean skipIoMappings, Boolean skipSubprocesses, Boolean failIfNotExists, ApiCallback<Void> _callback)` (asynchronously) Deletes a running process instance by id.
`okhttp3.Call`	`deleteProcessInstanceCall(String id, Boolean skipCustomListeners, Boolean skipIoMappings, Boolean skipSubprocesses, Boolean failIfNotExists, ApiCallback _callback)` Build call for deleteProcessInstance
`BatchDto`	`deleteProcessInstancesAsyncOperation(DeleteProcessInstancesDto deleteProcessInstancesDto)` Deletes multiple process instances asynchronously (batch).
`okhttp3.Call`	`deleteProcessInstancesAsyncOperationAsync(DeleteProcessInstancesDto deleteProcessInstancesDto, ApiCallback<BatchDto> _callback)` (asynchronously) Deletes multiple process instances asynchronously (batch).
`okhttp3.Call`	`deleteProcessInstancesAsyncOperationCall(DeleteProcessInstancesDto deleteProcessInstancesDto, ApiCallback _callback)` Build call for deleteProcessInstancesAsyncOperation
`ApiResponse<BatchDto>`	`deleteProcessInstancesAsyncOperationWithHttpInfo(DeleteProcessInstancesDto deleteProcessInstancesDto)` Deletes multiple process instances asynchronously (batch).
`void`	`deleteProcessInstanceVariable(String id, String varName)` Deletes a variable of a process instance by id.
`okhttp3.Call`	`deleteProcessInstanceVariableAsync(String id, String varName, ApiCallback<Void> _callback)` (asynchronously) Deletes a variable of a process instance by id.
`okhttp3.Call`	`deleteProcessInstanceVariableCall(String id, String varName, ApiCallback _callback)` Build call for deleteProcessInstanceVariable
`ApiResponse<Void>`	`deleteProcessInstanceVariableWithHttpInfo(String id, String varName)` Deletes a variable of a process instance by id.
`ApiResponse<Void>`	`deleteProcessInstanceWithHttpInfo(String id, Boolean skipCustomListeners, Boolean skipIoMappings, Boolean skipSubprocesses, Boolean failIfNotExists)` Deletes a running process instance by id.
`ActivityInstanceDto`	`getActivityInstanceTree(String id)` Retrieves an Activity Instance (Tree) for a given process instance by id.
`okhttp3.Call`	`getActivityInstanceTreeAsync(String id, ApiCallback<ActivityInstanceDto> _callback)` (asynchronously) Retrieves an Activity Instance (Tree) for a given process instance by id.
`okhttp3.Call`	`getActivityInstanceTreeCall(String id, ApiCallback _callback)` Build call for getActivityInstanceTree
`ApiResponse<ActivityInstanceDto>`	`getActivityInstanceTreeWithHttpInfo(String id)` Retrieves an Activity Instance (Tree) for a given process instance by id.
`ApiClient`	`getApiClient()`
`ProcessInstanceDto`	`getProcessInstance(String id)` Get Process Instance Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
`okhttp3.Call`	`getProcessInstanceAsync(String id, ApiCallback<ProcessInstanceDto> _callback)` Get Process Instance (asynchronously) Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
`okhttp3.Call`	`getProcessInstanceCall(String id, ApiCallback _callback)` Build call for getProcessInstance
`List<ProcessInstanceDto>`	getProcessInstances(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) Queries for process instances that fulfill given parameters.
`okhttp3.Call`	getProcessInstancesAsync(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, ApiCallback<List<ProcessInstanceDto>> _callback) (asynchronously) Queries for process instances that fulfill given parameters.
`okhttp3.Call`	getProcessInstancesCall(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, ApiCallback _callback) Build call for getProcessInstances
`CountResultDto`	getProcessInstancesCount(String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) Queries for the number of process instances that fulfill given parameters.
`okhttp3.Call`	getProcessInstancesCountAsync(String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, ApiCallback<CountResultDto> _callback) (asynchronously) Queries for the number of process instances that fulfill given parameters.
`okhttp3.Call`	getProcessInstancesCountCall(String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase, ApiCallback _callback) Build call for getProcessInstancesCount
`ApiResponse<CountResultDto>`	getProcessInstancesCountWithHttpInfo(String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) Queries for the number of process instances that fulfill given parameters.
`ApiResponse<List<ProcessInstanceDto>>`	getProcessInstancesWithHttpInfo(String sortBy, String sortOrder, Integer firstResult, Integer maxResults, String processInstanceIds, String businessKey, String businessKeyLike, String caseInstanceId, String processDefinitionId, String processDefinitionKey, String processDefinitionKeyIn, String processDefinitionKeyNotIn, String deploymentId, String superProcessInstance, String subProcessInstance, String superCaseInstance, String subCaseInstance, Boolean active, Boolean suspended, Boolean withIncident, String incidentId, String incidentType, String incidentMessage, String incidentMessageLike, String tenantIdIn, Boolean withoutTenantId, Boolean processDefinitionWithoutTenantId, String activityIdIn, Boolean rootProcessInstances, Boolean leafProcessInstances, String variables, Boolean variableNamesIgnoreCase, Boolean variableValuesIgnoreCase) Queries for process instances that fulfill given parameters.
`VariableValueDto`	`getProcessInstanceVariable(String id, String varName, Boolean deserializeValue)` Retrieves a variable of a given process instance by id.
`okhttp3.Call`	`getProcessInstanceVariableAsync(String id, String varName, Boolean deserializeValue, ApiCallback<VariableValueDto> _callback)` (asynchronously) Retrieves a variable of a given process instance by id.
`File`	`getProcessInstanceVariableBinary(String id, String varName)` Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name.
`okhttp3.Call`	`getProcessInstanceVariableBinaryAsync(String id, String varName, ApiCallback<File> _callback)` (asynchronously) Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name.
`okhttp3.Call`	`getProcessInstanceVariableBinaryCall(String id, String varName, ApiCallback _callback)` Build call for getProcessInstanceVariableBinary
`ApiResponse<File>`	`getProcessInstanceVariableBinaryWithHttpInfo(String id, String varName)` Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name.
`okhttp3.Call`	`getProcessInstanceVariableCall(String id, String varName, Boolean deserializeValue, ApiCallback _callback)` Build call for getProcessInstanceVariable
`Map<String,VariableValueDto>`	`getProcessInstanceVariables(String id, Boolean deserializeValue)` Retrieves all variables of a given process instance by id.
`okhttp3.Call`	`getProcessInstanceVariablesAsync(String id, Boolean deserializeValue, ApiCallback<Map<String,VariableValueDto>> _callback)` (asynchronously) Retrieves all variables of a given process instance by id.
`okhttp3.Call`	`getProcessInstanceVariablesCall(String id, Boolean deserializeValue, ApiCallback _callback)` Build call for getProcessInstanceVariables
`ApiResponse<Map<String,VariableValueDto>>`	`getProcessInstanceVariablesWithHttpInfo(String id, Boolean deserializeValue)` Retrieves all variables of a given process instance by id.
`ApiResponse<VariableValueDto>`	`getProcessInstanceVariableWithHttpInfo(String id, String varName, Boolean deserializeValue)` Retrieves a variable of a given process instance by id.
`ApiResponse<ProcessInstanceDto>`	`getProcessInstanceWithHttpInfo(String id)` Get Process Instance Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
`void`	`modifyProcessInstance(String id, ProcessInstanceModificationDto processInstanceModificationDto)` Submits a list of modification instructions to change a process instance's execution state.
`okhttp3.Call`	`modifyProcessInstanceAsync(String id, ProcessInstanceModificationDto processInstanceModificationDto, ApiCallback<Void> _callback)` (asynchronously) Submits a list of modification instructions to change a process instance's execution state.
`BatchDto`	`modifyProcessInstanceAsyncOperation(String id, ProcessInstanceModificationDto processInstanceModificationDto)` Submits a list of modification instructions to change a process instance's execution state async.
`okhttp3.Call`	`modifyProcessInstanceAsyncOperationAsync(String id, ProcessInstanceModificationDto processInstanceModificationDto, ApiCallback<BatchDto> _callback)` (asynchronously) Submits a list of modification instructions to change a process instance's execution state async.
`okhttp3.Call`	`modifyProcessInstanceAsyncOperationCall(String id, ProcessInstanceModificationDto processInstanceModificationDto, ApiCallback _callback)` Build call for modifyProcessInstanceAsyncOperation
`ApiResponse<BatchDto>`	`modifyProcessInstanceAsyncOperationWithHttpInfo(String id, ProcessInstanceModificationDto processInstanceModificationDto)` Submits a list of modification instructions to change a process instance's execution state async.
`okhttp3.Call`	`modifyProcessInstanceCall(String id, ProcessInstanceModificationDto processInstanceModificationDto, ApiCallback _callback)` Build call for modifyProcessInstance
`void`	`modifyProcessInstanceVariables(String id, PatchVariablesDto patchVariablesDto)` Updates or deletes the variables of a process instance by id.
`okhttp3.Call`	`modifyProcessInstanceVariablesAsync(String id, PatchVariablesDto patchVariablesDto, ApiCallback<Void> _callback)` (asynchronously) Updates or deletes the variables of a process instance by id.
`okhttp3.Call`	`modifyProcessInstanceVariablesCall(String id, PatchVariablesDto patchVariablesDto, ApiCallback _callback)` Build call for modifyProcessInstanceVariables
`ApiResponse<Void>`	`modifyProcessInstanceVariablesWithHttpInfo(String id, PatchVariablesDto patchVariablesDto)` Updates or deletes the variables of a process instance by id.
`ApiResponse<Void>`	`modifyProcessInstanceWithHttpInfo(String id, ProcessInstanceModificationDto processInstanceModificationDto)` Submits a list of modification instructions to change a process instance's execution state.
`List<ProcessInstanceDto>`	`queryProcessInstances(Integer firstResult, Integer maxResults, ProcessInstanceQueryDto processInstanceQueryDto)` Queries for process instances that fulfill given parameters through a JSON object.
`okhttp3.Call`	`queryProcessInstancesAsync(Integer firstResult, Integer maxResults, ProcessInstanceQueryDto processInstanceQueryDto, ApiCallback<List<ProcessInstanceDto>> _callback)` (asynchronously) Queries for process instances that fulfill given parameters through a JSON object.
`okhttp3.Call`	`queryProcessInstancesCall(Integer firstResult, Integer maxResults, ProcessInstanceQueryDto processInstanceQueryDto, ApiCallback _callback)` Build call for queryProcessInstances
`CountResultDto`	`queryProcessInstancesCount(ProcessInstanceQueryDto processInstanceQueryDto)` Queries for the number of process instances that fulfill the given parameters.
`okhttp3.Call`	`queryProcessInstancesCountAsync(ProcessInstanceQueryDto processInstanceQueryDto, ApiCallback<CountResultDto> _callback)` (asynchronously) Queries for the number of process instances that fulfill the given parameters.
`okhttp3.Call`	`queryProcessInstancesCountCall(ProcessInstanceQueryDto processInstanceQueryDto, ApiCallback _callback)` Build call for queryProcessInstancesCount
`ApiResponse<CountResultDto>`	`queryProcessInstancesCountWithHttpInfo(ProcessInstanceQueryDto processInstanceQueryDto)` Queries for the number of process instances that fulfill the given parameters.
`ApiResponse<List<ProcessInstanceDto>>`	`queryProcessInstancesWithHttpInfo(Integer firstResult, Integer maxResults, ProcessInstanceQueryDto processInstanceQueryDto)` Queries for process instances that fulfill given parameters through a JSON object.
`void`	`setApiClient(ApiClient apiClient)`
`void`	`setProcessInstanceVariable(String id, String varName, VariableValueDto variableValueDto)` Sets a variable of a given process instance by id.
`okhttp3.Call`	`setProcessInstanceVariableAsync(String id, String varName, VariableValueDto variableValueDto, ApiCallback<Void> _callback)` (asynchronously) Sets a variable of a given process instance by id.
`void`	`setProcessInstanceVariableBinary(String id, String varName, File data, String valueType)` Sets the serialized value for a binary variable or the binary value for a file variable.
`okhttp3.Call`	`setProcessInstanceVariableBinaryAsync(String id, String varName, File data, String valueType, ApiCallback<Void> _callback)` (asynchronously) Sets the serialized value for a binary variable or the binary value for a file variable.
`okhttp3.Call`	`setProcessInstanceVariableBinaryCall(String id, String varName, File data, String valueType, ApiCallback _callback)` Build call for setProcessInstanceVariableBinary
`ApiResponse<Void>`	`setProcessInstanceVariableBinaryWithHttpInfo(String id, String varName, File data, String valueType)` Sets the serialized value for a binary variable or the binary value for a file variable.
`okhttp3.Call`	`setProcessInstanceVariableCall(String id, String varName, VariableValueDto variableValueDto, ApiCallback _callback)` Build call for setProcessInstanceVariable
`ApiResponse<Void>`	`setProcessInstanceVariableWithHttpInfo(String id, String varName, VariableValueDto variableValueDto)` Sets a variable of a given process instance by id.
`BatchDto`	`setRetriesByProcess(SetJobRetriesByProcessDto setJobRetriesByProcessDto)` Create a batch to set retries of jobs associated with given processes asynchronously.
`okhttp3.Call`	`setRetriesByProcessAsync(SetJobRetriesByProcessDto setJobRetriesByProcessDto, ApiCallback<BatchDto> _callback)` (asynchronously) Create a batch to set retries of jobs associated with given processes asynchronously.
`okhttp3.Call`	`setRetriesByProcessCall(SetJobRetriesByProcessDto setJobRetriesByProcessDto, ApiCallback _callback)` Build call for setRetriesByProcess
`BatchDto`	`setRetriesByProcessHistoricQueryBased(SetJobRetriesByProcessDto setJobRetriesByProcessDto)` Create a batch to set retries of jobs asynchronously based on a historic process instance query.
`okhttp3.Call`	`setRetriesByProcessHistoricQueryBasedAsync(SetJobRetriesByProcessDto setJobRetriesByProcessDto, ApiCallback<BatchDto> _callback)` (asynchronously) Create a batch to set retries of jobs asynchronously based on a historic process instance query.
`okhttp3.Call`	`setRetriesByProcessHistoricQueryBasedCall(SetJobRetriesByProcessDto setJobRetriesByProcessDto, ApiCallback _callback)` Build call for setRetriesByProcessHistoricQueryBased
`ApiResponse<BatchDto>`	`setRetriesByProcessHistoricQueryBasedWithHttpInfo(SetJobRetriesByProcessDto setJobRetriesByProcessDto)` Create a batch to set retries of jobs asynchronously based on a historic process instance query.
`ApiResponse<BatchDto>`	`setRetriesByProcessWithHttpInfo(SetJobRetriesByProcessDto setJobRetriesByProcessDto)` Create a batch to set retries of jobs associated with given processes asynchronously.
`void`	`updateSuspensionState(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto)` Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery`
`okhttp3.Call`	`updateSuspensionStateAsync(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto, ApiCallback<Void> _callback)` (asynchronously) Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery`
`BatchDto`	`updateSuspensionStateAsyncOperation(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto)` Activates or suspends process instances asynchronously with a list of process instance ids, a process instance query, and/or a historical process instance query.
`okhttp3.Call`	`updateSuspensionStateAsyncOperationAsync(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto, ApiCallback<BatchDto> _callback)` (asynchronously) Activates or suspends process instances asynchronously with a list of process instance ids, a process instance query, and/or a historical process instance query.
`okhttp3.Call`	`updateSuspensionStateAsyncOperationCall(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto, ApiCallback _callback)` Build call for updateSuspensionStateAsyncOperation
`ApiResponse<BatchDto>`	`updateSuspensionStateAsyncOperationWithHttpInfo(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto)` Activates or suspends process instances asynchronously with a list of process instance ids, a process instance query, and/or a historical process instance query.
`void`	`updateSuspensionStateById(String id, SuspensionStateDto suspensionStateDto)` Activates or suspends a given process instance by id.
`okhttp3.Call`	`updateSuspensionStateByIdAsync(String id, SuspensionStateDto suspensionStateDto, ApiCallback<Void> _callback)` (asynchronously) Activates or suspends a given process instance by id.
`okhttp3.Call`	`updateSuspensionStateByIdCall(String id, SuspensionStateDto suspensionStateDto, ApiCallback _callback)` Build call for updateSuspensionStateById
`ApiResponse<Void>`	`updateSuspensionStateByIdWithHttpInfo(String id, SuspensionStateDto suspensionStateDto)` Activates or suspends a given process instance by id.
`okhttp3.Call`	`updateSuspensionStateCall(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto, ApiCallback _callback)` Build call for updateSuspensionState
`ApiResponse<Void>`	`updateSuspensionStateWithHttpInfo(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto)` Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProcessInstanceApi
```
public ProcessInstanceApi()
```
  - ProcessInstanceApi
```
public ProcessInstanceApi(ApiClient apiClient)
```
- Method Detail
  - getApiClient
```
public ApiClient getApiClient()
```
  - setApiClient
```
public void setApiClient(ApiClient apiClient)
```
  - deleteAsyncHistoricQueryBasedCall
```
public okhttp3.Call deleteAsyncHistoricQueryBasedCall(DeleteProcessInstancesDto deleteProcessInstancesDto,
                                                      ApiCallback _callback)
                                               throws ApiException
```
    Build call for deleteAsyncHistoricQueryBased
    
    Parameters:
    
    deleteProcessInstancesDto - **Unallowed property**: `processInstanceQuery` (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - deleteAsyncHistoricQueryBased
```
public BatchDto deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto deleteProcessInstancesDto)
                                       throws ApiException
```
    Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
    
    Parameters:
    
    deleteProcessInstancesDto - **Unallowed property**: `processInstanceQuery` (optional)
    
    Returns:
    
    BatchDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteAsyncHistoricQueryBasedWithHttpInfo
```
public ApiResponse<BatchDto> deleteAsyncHistoricQueryBasedWithHttpInfo(DeleteProcessInstancesDto deleteProcessInstancesDto)
                                                                throws ApiException
```
    Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
    
    Parameters:
    
    deleteProcessInstancesDto - **Unallowed property**: `processInstanceQuery` (optional)
    
    Returns:
    
    ApiResponse<BatchDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteAsyncHistoricQueryBasedAsync
```
public okhttp3.Call deleteAsyncHistoricQueryBasedAsync(DeleteProcessInstancesDto deleteProcessInstancesDto,
                                                       ApiCallback<BatchDto> _callback)
                                                throws ApiException
```
    (asynchronously) Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
    
    Parameters:
    
    deleteProcessInstancesDto - **Unallowed property**: `processInstanceQuery` (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
  - deleteProcessInstanceCall
```
public okhttp3.Call deleteProcessInstanceCall(String id,
                                              Boolean skipCustomListeners,
                                              Boolean skipIoMappings,
                                              Boolean skipSubprocesses,
                                              Boolean failIfNotExists,
                                              ApiCallback _callback)
                                       throws ApiException
```
    Build call for deleteProcessInstance
    
    Parameters:
    
    id - The id of the process instance to be deleted. (required)
    
    skipCustomListeners - If set to true, the custom listeners will be skipped. (optional, default to false)
    
    skipIoMappings - If set to true, the input/output mappings will be skipped. (optional, default to false)
    
    skipSubprocesses - If set to true, subprocesses related to deleted processes will be skipped. (optional, default to false)
    
    failIfNotExists - If set to false, the request will still be successful if the process id is not found. (optional, default to true)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - deleteProcessInstance
```
public void deleteProcessInstance(String id,
                                  Boolean skipCustomListeners,
                                  Boolean skipIoMappings,
                                  Boolean skipSubprocesses,
                                  Boolean failIfNotExists)
                           throws ApiException
```
    Deletes a running process instance by id.
    
    Parameters:
    
    id - The id of the process instance to be deleted. (required)
    
    skipCustomListeners - If set to true, the custom listeners will be skipped. (optional, default to false)
    
    skipIoMappings - If set to true, the input/output mappings will be skipped. (optional, default to false)
    
    skipSubprocesses - If set to true, subprocesses related to deleted processes will be skipped. (optional, default to false)
    
    failIfNotExists - If set to false, the request will still be successful if the process id is not found. (optional, default to true)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteProcessInstanceWithHttpInfo
```
public ApiResponse<Void> deleteProcessInstanceWithHttpInfo(String id,
                                                           Boolean skipCustomListeners,
                                                           Boolean skipIoMappings,
                                                           Boolean skipSubprocesses,
                                                           Boolean failIfNotExists)
                                                    throws ApiException
```
    Deletes a running process instance by id.
    
    Parameters:
    
    id - The id of the process instance to be deleted. (required)
    
    skipCustomListeners - If set to true, the custom listeners will be skipped. (optional, default to false)
    
    skipIoMappings - If set to true, the input/output mappings will be skipped. (optional, default to false)
    
    skipSubprocesses - If set to true, subprocesses related to deleted processes will be skipped. (optional, default to false)
    
    failIfNotExists - If set to false, the request will still be successful if the process id is not found. (optional, default to true)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteProcessInstanceAsync
```
public okhttp3.Call deleteProcessInstanceAsync(String id,
                                               Boolean skipCustomListeners,
                                               Boolean skipIoMappings,
                                               Boolean skipSubprocesses,
                                               Boolean failIfNotExists,
                                               ApiCallback<Void> _callback)
                                        throws ApiException
```
    (asynchronously) Deletes a running process instance by id.
    
    Parameters:
    
    id - The id of the process instance to be deleted. (required)
    
    skipCustomListeners - If set to true, the custom listeners will be skipped. (optional, default to false)
    
    skipIoMappings - If set to true, the input/output mappings will be skipped. (optional, default to false)
    
    skipSubprocesses - If set to true, subprocesses related to deleted processes will be skipped. (optional, default to false)
    
    failIfNotExists - If set to false, the request will still be successful if the process id is not found. (optional, default to true)
    
    _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
  - deleteProcessInstanceVariableCall
```
public okhttp3.Call deleteProcessInstanceVariableCall(String id,
                                                      String varName,
                                                      ApiCallback _callback)
                                               throws ApiException
```
    Build call for deleteProcessInstanceVariable
    
    Parameters:
    
    id - The id of the process instance to delete the variable from. (required)
    
    varName - The name of the variable to delete. (required)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - deleteProcessInstanceVariable
```
public void deleteProcessInstanceVariable(String id,
                                          String varName)
                                   throws ApiException
```
    Deletes a variable of a process instance by id.
    
    Parameters:
    
    id - The id of the process instance to delete the variable from. (required)
    
    varName - The name of the variable to delete. (required)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteProcessInstanceVariableWithHttpInfo
```
public ApiResponse<Void> deleteProcessInstanceVariableWithHttpInfo(String id,
                                                                   String varName)
                                                            throws ApiException
```
    Deletes a variable of a process instance by id.
    
    Parameters:
    
    id - The id of the process instance to delete the variable from. (required)
    
    varName - The name of the variable to delete. (required)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteProcessInstanceVariableAsync
```
public okhttp3.Call deleteProcessInstanceVariableAsync(String id,
                                                       String varName,
                                                       ApiCallback<Void> _callback)
                                                throws ApiException
```
    (asynchronously) Deletes a variable of a process instance by id.
    
    Parameters:
    
    id - The id of the process instance to delete the variable from. (required)
    
    varName - The name of the variable to delete. (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
  - deleteProcessInstancesAsyncOperationCall
```
public okhttp3.Call deleteProcessInstancesAsyncOperationCall(DeleteProcessInstancesDto deleteProcessInstancesDto,
                                                             ApiCallback _callback)
                                                      throws ApiException
```
    Build call for deleteProcessInstancesAsyncOperation
    
    Parameters:
    
    deleteProcessInstancesDto - **Unallowed property**: `historicProcessInstanceQuery` (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - deleteProcessInstancesAsyncOperation
```
public BatchDto deleteProcessInstancesAsyncOperation(DeleteProcessInstancesDto deleteProcessInstancesDto)
                                              throws ApiException
```
    Deletes multiple process instances asynchronously (batch).
    
    Parameters:
    
    deleteProcessInstancesDto - **Unallowed property**: `historicProcessInstanceQuery` (optional)
    
    Returns:
    
    BatchDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteProcessInstancesAsyncOperationWithHttpInfo
```
public ApiResponse<BatchDto> deleteProcessInstancesAsyncOperationWithHttpInfo(DeleteProcessInstancesDto deleteProcessInstancesDto)
                                                                       throws ApiException
```
    Deletes multiple process instances asynchronously (batch).
    
    Parameters:
    
    deleteProcessInstancesDto - **Unallowed property**: `historicProcessInstanceQuery` (optional)
    
    Returns:
    
    ApiResponse<BatchDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - deleteProcessInstancesAsyncOperationAsync
```
public okhttp3.Call deleteProcessInstancesAsyncOperationAsync(DeleteProcessInstancesDto deleteProcessInstancesDto,
                                                              ApiCallback<BatchDto> _callback)
                                                       throws ApiException
```
    (asynchronously) Deletes multiple process instances asynchronously (batch).
    
    Parameters:
    
    deleteProcessInstancesDto - **Unallowed property**: `historicProcessInstanceQuery` (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
  - getActivityInstanceTreeCall
```
public okhttp3.Call getActivityInstanceTreeCall(String id,
                                                ApiCallback _callback)
                                         throws ApiException
```
    Build call for getActivityInstanceTree
    
    Parameters:
    
    id - The id of the process instance for which the activity instance should be retrieved. (required)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getActivityInstanceTree
```
public ActivityInstanceDto getActivityInstanceTree(String id)
                                            throws ApiException
```
    Retrieves an Activity Instance (Tree) for a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance for which the activity instance should be retrieved. (required)
    
    Returns:
    
    ActivityInstanceDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getActivityInstanceTreeWithHttpInfo
```
public ApiResponse<ActivityInstanceDto> getActivityInstanceTreeWithHttpInfo(String id)
                                                                     throws ApiException
```
    Retrieves an Activity Instance (Tree) for a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance for which the activity instance should be retrieved. (required)
    
    Returns:
    
    ApiResponse<ActivityInstanceDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getActivityInstanceTreeAsync
```
public okhttp3.Call getActivityInstanceTreeAsync(String id,
                                                 ApiCallback<ActivityInstanceDto> _callback)
                                          throws ApiException
```
    (asynchronously) Retrieves an Activity Instance (Tree) for a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance for which the activity instance should 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
  - getProcessInstanceCall
```
public okhttp3.Call getProcessInstanceCall(String id,
                                           ApiCallback _callback)
                                    throws ApiException
```
    Build call for getProcessInstance
    
    Parameters:
    
    id - The id of the process instance to be retrieved. (required)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getProcessInstance
```
public ProcessInstanceDto getProcessInstance(String id)
                                      throws ApiException
```
    Get Process Instance Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
    
    Parameters:
    
    id - The id of the process instance to be retrieved. (required)
    
    Returns:
    
    ProcessInstanceDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstanceWithHttpInfo
```
public ApiResponse<ProcessInstanceDto> getProcessInstanceWithHttpInfo(String id)
                                                               throws ApiException
```
    Get Process Instance Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
    
    Parameters:
    
    id - The id of the process instance to be retrieved. (required)
    
    Returns:
    
    ApiResponse<ProcessInstanceDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstanceAsync
```
public okhttp3.Call getProcessInstanceAsync(String id,
                                            ApiCallback<ProcessInstanceDto> _callback)
                                     throws ApiException
```
    Get Process Instance (asynchronously) Retrieves a process instance by id, according to the `ProcessInstance` interface in the engine.
    
    Parameters:
    
    id - The id of the process instance 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
  - getProcessInstanceVariableCall
```
public okhttp3.Call getProcessInstanceVariableCall(String id,
                                                   String varName,
                                                   Boolean deserializeValue,
                                                   ApiCallback _callback)
                                            throws ApiException
```
    Build call for getProcessInstanceVariable
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getProcessInstanceVariable
```
public VariableValueDto getProcessInstanceVariable(String id,
                                                   String varName,
                                                   Boolean deserializeValue)
                                            throws ApiException
```
    Retrieves a variable of a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
    
    Returns:
    
    VariableValueDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstanceVariableWithHttpInfo
```
public ApiResponse<VariableValueDto> getProcessInstanceVariableWithHttpInfo(String id,
                                                                            String varName,
                                                                            Boolean deserializeValue)
                                                                     throws ApiException
```
    Retrieves a variable of a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
    
    Returns:
    
    ApiResponse<VariableValueDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstanceVariableAsync
```
public okhttp3.Call getProcessInstanceVariableAsync(String id,
                                                    String varName,
                                                    Boolean deserializeValue,
                                                    ApiCallback<VariableValueDto> _callback)
                                             throws ApiException
```
    (asynchronously) Retrieves a variable of a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
    
    _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
  - getProcessInstanceVariableBinaryCall
```
public okhttp3.Call getProcessInstanceVariableBinaryCall(String id,
                                                         String varName,
                                                         ApiCallback _callback)
                                                  throws ApiException
```
    Build call for getProcessInstanceVariableBinary
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getProcessInstanceVariableBinary
```
public File getProcessInstanceVariableBinary(String id,
                                             String varName)
                                      throws ApiException
```
    Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name. Applicable for byte array or file Process Variables.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    Returns:
    
    File
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstanceVariableBinaryWithHttpInfo
```
public ApiResponse<File> getProcessInstanceVariableBinaryWithHttpInfo(String id,
                                                                      String varName)
                                                               throws ApiException
```
    Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name. Applicable for byte array or file Process Variables.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    Returns:
    
    ApiResponse<File>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstanceVariableBinaryAsync
```
public okhttp3.Call getProcessInstanceVariableBinaryAsync(String id,
                                                          String varName,
                                                          ApiCallback<File> _callback)
                                                   throws ApiException
```
    (asynchronously) Retrieves the content of a Process Variable by the Process Instance id and the Process Variable name. Applicable for byte array or file Process Variables.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (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
  - getProcessInstanceVariablesCall
```
public okhttp3.Call getProcessInstanceVariablesCall(String id,
                                                    Boolean deserializeValue,
                                                    ApiCallback _callback)
                                             throws ApiException
```
    Build call for getProcessInstanceVariables
    
    Parameters:
    
    id - The id of the process instance to retrieve the variables from. (required)
    
    deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getProcessInstanceVariables
```
public Map<String,VariableValueDto> getProcessInstanceVariables(String id,
                                                                Boolean deserializeValue)
                                                         throws ApiException
```
    Retrieves all variables of a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variables from. (required)
    
    deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
    
    Returns:
    
    Map<String, VariableValueDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstanceVariablesWithHttpInfo
```
public ApiResponse<Map<String,VariableValueDto>> getProcessInstanceVariablesWithHttpInfo(String id,
                                                                                         Boolean deserializeValue)
                                                                                  throws ApiException
```
    Retrieves all variables of a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variables from. (required)
    
    deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
    
    Returns:
    
    ApiResponse<Map<String, VariableValueDto>>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstanceVariablesAsync
```
public okhttp3.Call getProcessInstanceVariablesAsync(String id,
                                                     Boolean deserializeValue,
                                                     ApiCallback<Map<String,VariableValueDto>> _callback)
                                              throws ApiException
```
    (asynchronously) Retrieves all variables of a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variables from. (required)
    
    deserializeValue - Determines whether serializable variable values (typically variables that store custom Java objects) should be deserialized on server side (default true). If set to true, a serializable variable will be deserialized on server side and transformed to JSON using [Jackson's](https://github.com/FasterXML/jackson) POJO/bean property introspection feature. Note that this requires the Java classes of the variable value to be on the REST API's classpath. If set to false, a serializable variable will be returned in its serialized format. For example, a variable that is serialized as XML will be returned as a JSON string containing XML. Note: While true is the default value for reasons of backward compatibility, we recommend setting this parameter to false when developing web applications that are independent of the Java process applications deployed to the engine. (optional, default to true)
    
    _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
  - getProcessInstancesCall
```
public okhttp3.Call getProcessInstancesCall(String sortBy,
                                            String sortOrder,
                                            Integer firstResult,
                                            Integer maxResults,
                                            String processInstanceIds,
                                            String businessKey,
                                            String businessKeyLike,
                                            String caseInstanceId,
                                            String processDefinitionId,
                                            String processDefinitionKey,
                                            String processDefinitionKeyIn,
                                            String processDefinitionKeyNotIn,
                                            String deploymentId,
                                            String superProcessInstance,
                                            String subProcessInstance,
                                            String superCaseInstance,
                                            String subCaseInstance,
                                            Boolean active,
                                            Boolean suspended,
                                            Boolean withIncident,
                                            String incidentId,
                                            String incidentType,
                                            String incidentMessage,
                                            String incidentMessageLike,
                                            String tenantIdIn,
                                            Boolean withoutTenantId,
                                            Boolean processDefinitionWithoutTenantId,
                                            String activityIdIn,
                                            Boolean rootProcessInstances,
                                            Boolean leafProcessInstances,
                                            String variables,
                                            Boolean variableNamesIgnoreCase,
                                            Boolean variableValuesIgnoreCase,
                                            ApiCallback _callback)
                                     throws ApiException
```
    Build call for getProcessInstances
    
    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)
    
    processInstanceIds - Filter by a comma-separated list of process instance ids. (optional)
    
    businessKey - Filter by process instance business key. (optional)
    
    businessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)
    
    caseInstanceId - Filter by case instance id. (optional)
    
    processDefinitionId - Filter by the deployment the id belongs to. (optional)
    
    processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)
    
    processDefinitionKeyIn - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
    
    processDefinitionKeyNotIn - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
    
    deploymentId - Filter by the deployment the id belongs to. (optional)
    
    superProcessInstance - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
    
    subProcessInstance - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
    
    superCaseInstance - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
    
    subCaseInstance - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
    
    active - Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    suspended - Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    withIncident - Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
    
    incidentId - Filter by the incident id. (optional)
    
    incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
    
    incidentMessage - Filter by the incident message. Exact match. (optional)
    
    incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
    
    tenantIdIn - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
    
    withoutTenantId - Only include process instances which belong to no tenant. (optional, default to false)
    
    processDefinitionWithoutTenantId - Only include process instances which process definition has no tenant id. (optional, default to false)
    
    activityIdIn - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
    
    rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional, default to false)
    
    leafProcessInstances - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
    
    variables - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
    
    variableNamesIgnoreCase - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
    
    variableValuesIgnoreCase - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getProcessInstances
```
public List<ProcessInstanceDto> getProcessInstances(String sortBy,
                                                    String sortOrder,
                                                    Integer firstResult,
                                                    Integer maxResults,
                                                    String processInstanceIds,
                                                    String businessKey,
                                                    String businessKeyLike,
                                                    String caseInstanceId,
                                                    String processDefinitionId,
                                                    String processDefinitionKey,
                                                    String processDefinitionKeyIn,
                                                    String processDefinitionKeyNotIn,
                                                    String deploymentId,
                                                    String superProcessInstance,
                                                    String subProcessInstance,
                                                    String superCaseInstance,
                                                    String subCaseInstance,
                                                    Boolean active,
                                                    Boolean suspended,
                                                    Boolean withIncident,
                                                    String incidentId,
                                                    String incidentType,
                                                    String incidentMessage,
                                                    String incidentMessageLike,
                                                    String tenantIdIn,
                                                    Boolean withoutTenantId,
                                                    Boolean processDefinitionWithoutTenantId,
                                                    String activityIdIn,
                                                    Boolean rootProcessInstances,
                                                    Boolean leafProcessInstances,
                                                    String variables,
                                                    Boolean variableNamesIgnoreCase,
                                                    Boolean variableValuesIgnoreCase)
                                             throws ApiException
```
    Queries for process instances that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of process instances. The size of the result set can be retrieved by using the Get Instance 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)
    
    processInstanceIds - Filter by a comma-separated list of process instance ids. (optional)
    
    businessKey - Filter by process instance business key. (optional)
    
    businessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)
    
    caseInstanceId - Filter by case instance id. (optional)
    
    processDefinitionId - Filter by the deployment the id belongs to. (optional)
    
    processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)
    
    processDefinitionKeyIn - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
    
    processDefinitionKeyNotIn - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
    
    deploymentId - Filter by the deployment the id belongs to. (optional)
    
    superProcessInstance - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
    
    subProcessInstance - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
    
    superCaseInstance - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
    
    subCaseInstance - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
    
    active - Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    suspended - Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    withIncident - Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
    
    incidentId - Filter by the incident id. (optional)
    
    incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
    
    incidentMessage - Filter by the incident message. Exact match. (optional)
    
    incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
    
    tenantIdIn - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
    
    withoutTenantId - Only include process instances which belong to no tenant. (optional, default to false)
    
    processDefinitionWithoutTenantId - Only include process instances which process definition has no tenant id. (optional, default to false)
    
    activityIdIn - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
    
    rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional, default to false)
    
    leafProcessInstances - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
    
    variables - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
    
    variableNamesIgnoreCase - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
    
    variableValuesIgnoreCase - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
    
    Returns:
    
    List<ProcessInstanceDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstancesWithHttpInfo
```
public ApiResponse<List<ProcessInstanceDto>> getProcessInstancesWithHttpInfo(String sortBy,
                                                                             String sortOrder,
                                                                             Integer firstResult,
                                                                             Integer maxResults,
                                                                             String processInstanceIds,
                                                                             String businessKey,
                                                                             String businessKeyLike,
                                                                             String caseInstanceId,
                                                                             String processDefinitionId,
                                                                             String processDefinitionKey,
                                                                             String processDefinitionKeyIn,
                                                                             String processDefinitionKeyNotIn,
                                                                             String deploymentId,
                                                                             String superProcessInstance,
                                                                             String subProcessInstance,
                                                                             String superCaseInstance,
                                                                             String subCaseInstance,
                                                                             Boolean active,
                                                                             Boolean suspended,
                                                                             Boolean withIncident,
                                                                             String incidentId,
                                                                             String incidentType,
                                                                             String incidentMessage,
                                                                             String incidentMessageLike,
                                                                             String tenantIdIn,
                                                                             Boolean withoutTenantId,
                                                                             Boolean processDefinitionWithoutTenantId,
                                                                             String activityIdIn,
                                                                             Boolean rootProcessInstances,
                                                                             Boolean leafProcessInstances,
                                                                             String variables,
                                                                             Boolean variableNamesIgnoreCase,
                                                                             Boolean variableValuesIgnoreCase)
                                                                      throws ApiException
```
    Queries for process instances that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of process instances. The size of the result set can be retrieved by using the Get Instance 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)
    
    processInstanceIds - Filter by a comma-separated list of process instance ids. (optional)
    
    businessKey - Filter by process instance business key. (optional)
    
    businessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)
    
    caseInstanceId - Filter by case instance id. (optional)
    
    processDefinitionId - Filter by the deployment the id belongs to. (optional)
    
    processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)
    
    processDefinitionKeyIn - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
    
    processDefinitionKeyNotIn - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
    
    deploymentId - Filter by the deployment the id belongs to. (optional)
    
    superProcessInstance - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
    
    subProcessInstance - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
    
    superCaseInstance - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
    
    subCaseInstance - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
    
    active - Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    suspended - Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    withIncident - Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
    
    incidentId - Filter by the incident id. (optional)
    
    incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
    
    incidentMessage - Filter by the incident message. Exact match. (optional)
    
    incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
    
    tenantIdIn - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
    
    withoutTenantId - Only include process instances which belong to no tenant. (optional, default to false)
    
    processDefinitionWithoutTenantId - Only include process instances which process definition has no tenant id. (optional, default to false)
    
    activityIdIn - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
    
    rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional, default to false)
    
    leafProcessInstances - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
    
    variables - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
    
    variableNamesIgnoreCase - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
    
    variableValuesIgnoreCase - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
    
    Returns:
    
    ApiResponse<List<ProcessInstanceDto>>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstancesAsync
```
public okhttp3.Call getProcessInstancesAsync(String sortBy,
                                             String sortOrder,
                                             Integer firstResult,
                                             Integer maxResults,
                                             String processInstanceIds,
                                             String businessKey,
                                             String businessKeyLike,
                                             String caseInstanceId,
                                             String processDefinitionId,
                                             String processDefinitionKey,
                                             String processDefinitionKeyIn,
                                             String processDefinitionKeyNotIn,
                                             String deploymentId,
                                             String superProcessInstance,
                                             String subProcessInstance,
                                             String superCaseInstance,
                                             String subCaseInstance,
                                             Boolean active,
                                             Boolean suspended,
                                             Boolean withIncident,
                                             String incidentId,
                                             String incidentType,
                                             String incidentMessage,
                                             String incidentMessageLike,
                                             String tenantIdIn,
                                             Boolean withoutTenantId,
                                             Boolean processDefinitionWithoutTenantId,
                                             String activityIdIn,
                                             Boolean rootProcessInstances,
                                             Boolean leafProcessInstances,
                                             String variables,
                                             Boolean variableNamesIgnoreCase,
                                             Boolean variableValuesIgnoreCase,
                                             ApiCallback<List<ProcessInstanceDto>> _callback)
                                      throws ApiException
```
    (asynchronously) Queries for process instances that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of process instances. The size of the result set can be retrieved by using the Get Instance 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)
    
    processInstanceIds - Filter by a comma-separated list of process instance ids. (optional)
    
    businessKey - Filter by process instance business key. (optional)
    
    businessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)
    
    caseInstanceId - Filter by case instance id. (optional)
    
    processDefinitionId - Filter by the deployment the id belongs to. (optional)
    
    processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)
    
    processDefinitionKeyIn - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
    
    processDefinitionKeyNotIn - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
    
    deploymentId - Filter by the deployment the id belongs to. (optional)
    
    superProcessInstance - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
    
    subProcessInstance - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
    
    superCaseInstance - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
    
    subCaseInstance - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
    
    active - Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    suspended - Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    withIncident - Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
    
    incidentId - Filter by the incident id. (optional)
    
    incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
    
    incidentMessage - Filter by the incident message. Exact match. (optional)
    
    incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
    
    tenantIdIn - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
    
    withoutTenantId - Only include process instances which belong to no tenant. (optional, default to false)
    
    processDefinitionWithoutTenantId - Only include process instances which process definition has no tenant id. (optional, default to false)
    
    activityIdIn - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
    
    rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional, default to false)
    
    leafProcessInstances - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
    
    variables - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
    
    variableNamesIgnoreCase - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
    
    variableValuesIgnoreCase - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
    
    _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
  - getProcessInstancesCountCall
```
public okhttp3.Call getProcessInstancesCountCall(String processInstanceIds,
                                                 String businessKey,
                                                 String businessKeyLike,
                                                 String caseInstanceId,
                                                 String processDefinitionId,
                                                 String processDefinitionKey,
                                                 String processDefinitionKeyIn,
                                                 String processDefinitionKeyNotIn,
                                                 String deploymentId,
                                                 String superProcessInstance,
                                                 String subProcessInstance,
                                                 String superCaseInstance,
                                                 String subCaseInstance,
                                                 Boolean active,
                                                 Boolean suspended,
                                                 Boolean withIncident,
                                                 String incidentId,
                                                 String incidentType,
                                                 String incidentMessage,
                                                 String incidentMessageLike,
                                                 String tenantIdIn,
                                                 Boolean withoutTenantId,
                                                 Boolean processDefinitionWithoutTenantId,
                                                 String activityIdIn,
                                                 Boolean rootProcessInstances,
                                                 Boolean leafProcessInstances,
                                                 String variables,
                                                 Boolean variableNamesIgnoreCase,
                                                 Boolean variableValuesIgnoreCase,
                                                 ApiCallback _callback)
                                          throws ApiException
```
    Build call for getProcessInstancesCount
    
    Parameters:
    
    processInstanceIds - Filter by a comma-separated list of process instance ids. (optional)
    
    businessKey - Filter by process instance business key. (optional)
    
    businessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)
    
    caseInstanceId - Filter by case instance id. (optional)
    
    processDefinitionId - Filter by the deployment the id belongs to. (optional)
    
    processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)
    
    processDefinitionKeyIn - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
    
    processDefinitionKeyNotIn - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
    
    deploymentId - Filter by the deployment the id belongs to. (optional)
    
    superProcessInstance - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
    
    subProcessInstance - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
    
    superCaseInstance - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
    
    subCaseInstance - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
    
    active - Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    suspended - Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    withIncident - Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
    
    incidentId - Filter by the incident id. (optional)
    
    incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
    
    incidentMessage - Filter by the incident message. Exact match. (optional)
    
    incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
    
    tenantIdIn - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
    
    withoutTenantId - Only include process instances which belong to no tenant. (optional, default to false)
    
    processDefinitionWithoutTenantId - Only include process instances which process definition has no tenant id. (optional, default to false)
    
    activityIdIn - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
    
    rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional, default to false)
    
    leafProcessInstances - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
    
    variables - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
    
    variableNamesIgnoreCase - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
    
    variableValuesIgnoreCase - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - getProcessInstancesCount
```
public CountResultDto getProcessInstancesCount(String processInstanceIds,
                                               String businessKey,
                                               String businessKeyLike,
                                               String caseInstanceId,
                                               String processDefinitionId,
                                               String processDefinitionKey,
                                               String processDefinitionKeyIn,
                                               String processDefinitionKeyNotIn,
                                               String deploymentId,
                                               String superProcessInstance,
                                               String subProcessInstance,
                                               String superCaseInstance,
                                               String subCaseInstance,
                                               Boolean active,
                                               Boolean suspended,
                                               Boolean withIncident,
                                               String incidentId,
                                               String incidentType,
                                               String incidentMessage,
                                               String incidentMessageLike,
                                               String tenantIdIn,
                                               Boolean withoutTenantId,
                                               Boolean processDefinitionWithoutTenantId,
                                               String activityIdIn,
                                               Boolean rootProcessInstances,
                                               Boolean leafProcessInstances,
                                               String variables,
                                               Boolean variableNamesIgnoreCase,
                                               Boolean variableValuesIgnoreCase)
                                        throws ApiException
```
    Queries for the number of process instances that fulfill given parameters.
    
    Parameters:
    
    processInstanceIds - Filter by a comma-separated list of process instance ids. (optional)
    
    businessKey - Filter by process instance business key. (optional)
    
    businessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)
    
    caseInstanceId - Filter by case instance id. (optional)
    
    processDefinitionId - Filter by the deployment the id belongs to. (optional)
    
    processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)
    
    processDefinitionKeyIn - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
    
    processDefinitionKeyNotIn - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
    
    deploymentId - Filter by the deployment the id belongs to. (optional)
    
    superProcessInstance - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
    
    subProcessInstance - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
    
    superCaseInstance - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
    
    subCaseInstance - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
    
    active - Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    suspended - Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    withIncident - Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
    
    incidentId - Filter by the incident id. (optional)
    
    incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
    
    incidentMessage - Filter by the incident message. Exact match. (optional)
    
    incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
    
    tenantIdIn - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
    
    withoutTenantId - Only include process instances which belong to no tenant. (optional, default to false)
    
    processDefinitionWithoutTenantId - Only include process instances which process definition has no tenant id. (optional, default to false)
    
    activityIdIn - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
    
    rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional, default to false)
    
    leafProcessInstances - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
    
    variables - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
    
    variableNamesIgnoreCase - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
    
    variableValuesIgnoreCase - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
    
    Returns:
    
    CountResultDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstancesCountWithHttpInfo
```
public ApiResponse<CountResultDto> getProcessInstancesCountWithHttpInfo(String processInstanceIds,
                                                                        String businessKey,
                                                                        String businessKeyLike,
                                                                        String caseInstanceId,
                                                                        String processDefinitionId,
                                                                        String processDefinitionKey,
                                                                        String processDefinitionKeyIn,
                                                                        String processDefinitionKeyNotIn,
                                                                        String deploymentId,
                                                                        String superProcessInstance,
                                                                        String subProcessInstance,
                                                                        String superCaseInstance,
                                                                        String subCaseInstance,
                                                                        Boolean active,
                                                                        Boolean suspended,
                                                                        Boolean withIncident,
                                                                        String incidentId,
                                                                        String incidentType,
                                                                        String incidentMessage,
                                                                        String incidentMessageLike,
                                                                        String tenantIdIn,
                                                                        Boolean withoutTenantId,
                                                                        Boolean processDefinitionWithoutTenantId,
                                                                        String activityIdIn,
                                                                        Boolean rootProcessInstances,
                                                                        Boolean leafProcessInstances,
                                                                        String variables,
                                                                        Boolean variableNamesIgnoreCase,
                                                                        Boolean variableValuesIgnoreCase)
                                                                 throws ApiException
```
    Queries for the number of process instances that fulfill given parameters.
    
    Parameters:
    
    processInstanceIds - Filter by a comma-separated list of process instance ids. (optional)
    
    businessKey - Filter by process instance business key. (optional)
    
    businessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)
    
    caseInstanceId - Filter by case instance id. (optional)
    
    processDefinitionId - Filter by the deployment the id belongs to. (optional)
    
    processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)
    
    processDefinitionKeyIn - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
    
    processDefinitionKeyNotIn - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
    
    deploymentId - Filter by the deployment the id belongs to. (optional)
    
    superProcessInstance - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
    
    subProcessInstance - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
    
    superCaseInstance - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
    
    subCaseInstance - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
    
    active - Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    suspended - Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    withIncident - Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
    
    incidentId - Filter by the incident id. (optional)
    
    incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
    
    incidentMessage - Filter by the incident message. Exact match. (optional)
    
    incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
    
    tenantIdIn - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
    
    withoutTenantId - Only include process instances which belong to no tenant. (optional, default to false)
    
    processDefinitionWithoutTenantId - Only include process instances which process definition has no tenant id. (optional, default to false)
    
    activityIdIn - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
    
    rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional, default to false)
    
    leafProcessInstances - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
    
    variables - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
    
    variableNamesIgnoreCase - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
    
    variableValuesIgnoreCase - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
    
    Returns:
    
    ApiResponse<CountResultDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - getProcessInstancesCountAsync
```
public okhttp3.Call getProcessInstancesCountAsync(String processInstanceIds,
                                                  String businessKey,
                                                  String businessKeyLike,
                                                  String caseInstanceId,
                                                  String processDefinitionId,
                                                  String processDefinitionKey,
                                                  String processDefinitionKeyIn,
                                                  String processDefinitionKeyNotIn,
                                                  String deploymentId,
                                                  String superProcessInstance,
                                                  String subProcessInstance,
                                                  String superCaseInstance,
                                                  String subCaseInstance,
                                                  Boolean active,
                                                  Boolean suspended,
                                                  Boolean withIncident,
                                                  String incidentId,
                                                  String incidentType,
                                                  String incidentMessage,
                                                  String incidentMessageLike,
                                                  String tenantIdIn,
                                                  Boolean withoutTenantId,
                                                  Boolean processDefinitionWithoutTenantId,
                                                  String activityIdIn,
                                                  Boolean rootProcessInstances,
                                                  Boolean leafProcessInstances,
                                                  String variables,
                                                  Boolean variableNamesIgnoreCase,
                                                  Boolean variableValuesIgnoreCase,
                                                  ApiCallback<CountResultDto> _callback)
                                           throws ApiException
```
    (asynchronously) Queries for the number of process instances that fulfill given parameters.
    
    Parameters:
    
    processInstanceIds - Filter by a comma-separated list of process instance ids. (optional)
    
    businessKey - Filter by process instance business key. (optional)
    
    businessKeyLike - Filter by process instance business key that the parameter is a substring of. (optional)
    
    caseInstanceId - Filter by case instance id. (optional)
    
    processDefinitionId - Filter by the deployment the id belongs to. (optional)
    
    processDefinitionKey - Filter by the key of the process definition the instances run on. (optional)
    
    processDefinitionKeyIn - Filter by a comma-separated list of process definition keys. A process instance must have one of the given process definition keys. (optional)
    
    processDefinitionKeyNotIn - Exclude instances by a comma-separated list of process definition keys. A process instance must not have one of the given process definition keys. (optional)
    
    deploymentId - Filter by the deployment the id belongs to. (optional)
    
    superProcessInstance - Restrict query to all process instances that are sub process instances of the given process instance. Takes a process instance id. (optional)
    
    subProcessInstance - Restrict query to all process instances that have the given process instance as a sub process instance. Takes a process instance id. (optional)
    
    superCaseInstance - Restrict query to all process instances that are sub process instances of the given case instance. Takes a case instance id. (optional)
    
    subCaseInstance - Restrict query to all process instances that have the given case instance as a sub case instance. Takes a case instance id. (optional)
    
    active - Only include active process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    suspended - Only include suspended process instances. Value may only be true, as false is the default behavior. (optional, default to false)
    
    withIncident - Filter by presence of incidents. Selects only process instances that have an incident. (optional, default to false)
    
    incidentId - Filter by the incident id. (optional)
    
    incidentType - Filter by the incident type. See the [User Guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/incidents/#incident-types) for a list of incident types. (optional)
    
    incidentMessage - Filter by the incident message. Exact match. (optional)
    
    incidentMessageLike - Filter by the incident message that the parameter is a substring of. (optional)
    
    tenantIdIn - Filter by a comma-separated list of tenant ids. A process instance must have one of the given tenant ids. (optional)
    
    withoutTenantId - Only include process instances which belong to no tenant. (optional, default to false)
    
    processDefinitionWithoutTenantId - Only include process instances which process definition has no tenant id. (optional, default to false)
    
    activityIdIn - Filter by a comma-separated list of activity ids. A process instance must currently wait in a leaf activity with one of the given activity ids. (optional)
    
    rootProcessInstances - Restrict the query to all process instances that are top level process instances. (optional, default to false)
    
    leafProcessInstances - Restrict the query to all process instances that are leaf instances. (i.e. don't have any sub instances). (optional, default to false)
    
    variables - Only include process instances that have variables with certain values. Variable filtering expressions are comma-separated and are structured as follows: A valid parameter value has the form `key_operator_value`. `key` is the variable name, `operator` is the comparison operator to be used and `value` the variable value. **Note**: Values are always treated as String objects on server side. Valid `operator` values are: `eq` - equal to; `neq` - not equal to; `gt` - greater than; `gteq` - greater than or equal to; `lt` - lower than; `lteq` - lower than or equal to; `like`. `key` and `value` may not contain underscore or comma characters. (optional)
    
    variableNamesIgnoreCase - Match all variable names in this query case-insensitively. If set to true variableName and variablename are treated as equal. (optional, default to false)
    
    variableValuesIgnoreCase - Match all variable values in this query case-insensitively. If set to true variableValue and variablevalue are treated as equal. (optional, default to false)
    
    _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
  - modifyProcessInstanceCall
```
public okhttp3.Call modifyProcessInstanceCall(String id,
                                              ProcessInstanceModificationDto processInstanceModificationDto,
                                              ApiCallback _callback)
                                       throws ApiException
```
    Build call for modifyProcessInstance
    
    Parameters:
    
    id - The id of the process instance to modify. (required)
    
    processInstanceModificationDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - modifyProcessInstance
```
public void modifyProcessInstance(String id,
                                  ProcessInstanceModificationDto processInstanceModificationDto)
                           throws ApiException
```
    Submits a list of modification instructions to change a process instance's execution state. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Canceling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed immediately and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/process-instance-modification/).
    
    Parameters:
    
    id - The id of the process instance to modify. (required)
    
    processInstanceModificationDto - (optional)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - modifyProcessInstanceWithHttpInfo
```
public ApiResponse<Void> modifyProcessInstanceWithHttpInfo(String id,
                                                           ProcessInstanceModificationDto processInstanceModificationDto)
                                                    throws ApiException
```
    Submits a list of modification instructions to change a process instance's execution state. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Canceling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed immediately and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/process-instance-modification/).
    
    Parameters:
    
    id - The id of the process instance to modify. (required)
    
    processInstanceModificationDto - (optional)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - modifyProcessInstanceAsync
```
public okhttp3.Call modifyProcessInstanceAsync(String id,
                                               ProcessInstanceModificationDto processInstanceModificationDto,
                                               ApiCallback<Void> _callback)
                                        throws ApiException
```
    (asynchronously) Submits a list of modification instructions to change a process instance's execution state. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Canceling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed immediately and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/develop/user-guide/process-engine/process-instance-modification/).
    
    Parameters:
    
    id - The id of the process instance to modify. (required)
    
    processInstanceModificationDto - (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
  - modifyProcessInstanceAsyncOperationCall
```
public okhttp3.Call modifyProcessInstanceAsyncOperationCall(String id,
                                                            ProcessInstanceModificationDto processInstanceModificationDto,
                                                            ApiCallback _callback)
                                                     throws ApiException
```
    Build call for modifyProcessInstanceAsyncOperation
    
    Parameters:
    
    id - The id of the process instance to modify. (required)
    
    processInstanceModificationDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - modifyProcessInstanceAsyncOperation
```
public BatchDto modifyProcessInstanceAsyncOperation(String id,
                                                    ProcessInstanceModificationDto processInstanceModificationDto)
                                             throws ApiException
```
    Submits a list of modification instructions to change a process instance's execution state async. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Cancelling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed asynchronous and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-instance-modification/).
    
    Parameters:
    
    id - The id of the process instance to modify. (required)
    
    processInstanceModificationDto - (optional)
    
    Returns:
    
    BatchDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - modifyProcessInstanceAsyncOperationWithHttpInfo
```
public ApiResponse<BatchDto> modifyProcessInstanceAsyncOperationWithHttpInfo(String id,
                                                                             ProcessInstanceModificationDto processInstanceModificationDto)
                                                                      throws ApiException
```
    Submits a list of modification instructions to change a process instance's execution state async. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Cancelling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed asynchronous and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-instance-modification/).
    
    Parameters:
    
    id - The id of the process instance to modify. (required)
    
    processInstanceModificationDto - (optional)
    
    Returns:
    
    ApiResponse<BatchDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - modifyProcessInstanceAsyncOperationAsync
```
public okhttp3.Call modifyProcessInstanceAsyncOperationAsync(String id,
                                                             ProcessInstanceModificationDto processInstanceModificationDto,
                                                             ApiCallback<BatchDto> _callback)
                                                      throws ApiException
```
    (asynchronously) Submits a list of modification instructions to change a process instance's execution state async. A modification instruction is one of the following: * Starting execution before an activity * Starting execution after an activity on its single outgoing sequence flow * Starting execution on a specific sequence flow * Cancelling an activity instance, transition instance, or all instances (activity or transition) for an activity Instructions are executed asynchronous and in the order they are provided in this request's body. Variables can be provided with every starting instruction. The exact semantics of modification can be read about in the [User guide](https://docs.camunda.org/manual/7.13/user-guide/process-engine/process-instance-modification/).
    
    Parameters:
    
    id - The id of the process instance to modify. (required)
    
    processInstanceModificationDto - (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
  - modifyProcessInstanceVariablesCall
```
public okhttp3.Call modifyProcessInstanceVariablesCall(String id,
                                                       PatchVariablesDto patchVariablesDto,
                                                       ApiCallback _callback)
                                                throws ApiException
```
    Build call for modifyProcessInstanceVariables
    
    Parameters:
    
    id - The id of the process instance to set variables for. (required)
    
    patchVariablesDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - modifyProcessInstanceVariables
```
public void modifyProcessInstanceVariables(String id,
                                           PatchVariablesDto patchVariablesDto)
                                    throws ApiException
```
    Updates or deletes the variables of a process instance by id. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
    
    Parameters:
    
    id - The id of the process instance to set variables for. (required)
    
    patchVariablesDto - (optional)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - modifyProcessInstanceVariablesWithHttpInfo
```
public ApiResponse<Void> modifyProcessInstanceVariablesWithHttpInfo(String id,
                                                                    PatchVariablesDto patchVariablesDto)
                                                             throws ApiException
```
    Updates or deletes the variables of a process instance by id. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
    
    Parameters:
    
    id - The id of the process instance to set variables for. (required)
    
    patchVariablesDto - (optional)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - modifyProcessInstanceVariablesAsync
```
public okhttp3.Call modifyProcessInstanceVariablesAsync(String id,
                                                        PatchVariablesDto patchVariablesDto,
                                                        ApiCallback<Void> _callback)
                                                 throws ApiException
```
    (asynchronously) Updates or deletes the variables of a process instance by id. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
    
    Parameters:
    
    id - The id of the process instance to set variables for. (required)
    
    patchVariablesDto - (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
  - queryProcessInstancesCall
```
public okhttp3.Call queryProcessInstancesCall(Integer firstResult,
                                              Integer maxResults,
                                              ProcessInstanceQueryDto processInstanceQueryDto,
                                              ApiCallback _callback)
                                       throws ApiException
```
    Build call for queryProcessInstances
    
    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)
    
    processInstanceQueryDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - queryProcessInstances
```
public List<ProcessInstanceDto> queryProcessInstances(Integer firstResult,
                                                      Integer maxResults,
                                                      ProcessInstanceQueryDto processInstanceQueryDto)
                                               throws ApiException
```
    Queries for process instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the Get Instances method because it allows filtering by multiple process variables of types `string`, `number` or `boolean`.
    
    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)
    
    processInstanceQueryDto - (optional)
    
    Returns:
    
    List<ProcessInstanceDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - queryProcessInstancesWithHttpInfo
```
public ApiResponse<List<ProcessInstanceDto>> queryProcessInstancesWithHttpInfo(Integer firstResult,
                                                                               Integer maxResults,
                                                                               ProcessInstanceQueryDto processInstanceQueryDto)
                                                                        throws ApiException
```
    Queries for process instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the Get Instances method because it allows filtering by multiple process variables of types `string`, `number` or `boolean`.
    
    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)
    
    processInstanceQueryDto - (optional)
    
    Returns:
    
    ApiResponse<List<ProcessInstanceDto>>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - queryProcessInstancesAsync
```
public okhttp3.Call queryProcessInstancesAsync(Integer firstResult,
                                               Integer maxResults,
                                               ProcessInstanceQueryDto processInstanceQueryDto,
                                               ApiCallback<List<ProcessInstanceDto>> _callback)
                                        throws ApiException
```
    (asynchronously) Queries for process instances that fulfill given parameters through a JSON object. This method is slightly more powerful than the Get Instances method because it allows filtering by multiple process variables of types `string`, `number` or `boolean`.
    
    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)
    
    processInstanceQueryDto - (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
  - queryProcessInstancesCountCall
```
public okhttp3.Call queryProcessInstancesCountCall(ProcessInstanceQueryDto processInstanceQueryDto,
                                                   ApiCallback _callback)
                                            throws ApiException
```
    Build call for queryProcessInstancesCount
    
    Parameters:
    
    processInstanceQueryDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - queryProcessInstancesCount
```
public CountResultDto queryProcessInstancesCount(ProcessInstanceQueryDto processInstanceQueryDto)
                                          throws ApiException
```
    Queries for the number of process instances that fulfill the given parameters. This method takes the same message body as the Get Instances (POST) method and therefore it is slightly more powerful than the Get Instance Count method.
    
    Parameters:
    
    processInstanceQueryDto - (optional)
    
    Returns:
    
    CountResultDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - queryProcessInstancesCountWithHttpInfo
```
public ApiResponse<CountResultDto> queryProcessInstancesCountWithHttpInfo(ProcessInstanceQueryDto processInstanceQueryDto)
                                                                   throws ApiException
```
    Queries for the number of process instances that fulfill the given parameters. This method takes the same message body as the Get Instances (POST) method and therefore it is slightly more powerful than the Get Instance Count method.
    
    Parameters:
    
    processInstanceQueryDto - (optional)
    
    Returns:
    
    ApiResponse<CountResultDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - queryProcessInstancesCountAsync
```
public okhttp3.Call queryProcessInstancesCountAsync(ProcessInstanceQueryDto processInstanceQueryDto,
                                                    ApiCallback<CountResultDto> _callback)
                                             throws ApiException
```
    (asynchronously) Queries for the number of process instances that fulfill the given parameters. This method takes the same message body as the Get Instances (POST) method and therefore it is slightly more powerful than the Get Instance Count method.
    
    Parameters:
    
    processInstanceQueryDto - (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
  - setProcessInstanceVariableCall
```
public okhttp3.Call setProcessInstanceVariableCall(String id,
                                                   String varName,
                                                   VariableValueDto variableValueDto,
                                                   ApiCallback _callback)
                                            throws ApiException
```
    Build call for setProcessInstanceVariable
    
    Parameters:
    
    id - The id of the process instance to set the variable for. (required)
    
    varName - The name of the variable to set. (required)
    
    variableValueDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - setProcessInstanceVariable
```
public void setProcessInstanceVariable(String id,
                                       String varName,
                                       VariableValueDto variableValueDto)
                                throws ApiException
```
    Sets a variable of a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to set the variable for. (required)
    
    varName - The name of the variable to set. (required)
    
    variableValueDto - (optional)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setProcessInstanceVariableWithHttpInfo
```
public ApiResponse<Void> setProcessInstanceVariableWithHttpInfo(String id,
                                                                String varName,
                                                                VariableValueDto variableValueDto)
                                                         throws ApiException
```
    Sets a variable of a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to set the variable for. (required)
    
    varName - The name of the variable to set. (required)
    
    variableValueDto - (optional)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setProcessInstanceVariableAsync
```
public okhttp3.Call setProcessInstanceVariableAsync(String id,
                                                    String varName,
                                                    VariableValueDto variableValueDto,
                                                    ApiCallback<Void> _callback)
                                             throws ApiException
```
    (asynchronously) Sets a variable of a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to set the variable for. (required)
    
    varName - The name of the variable to set. (required)
    
    variableValueDto - (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
  - setProcessInstanceVariableBinaryCall
```
public okhttp3.Call setProcessInstanceVariableBinaryCall(String id,
                                                         String varName,
                                                         File data,
                                                         String valueType,
                                                         ApiCallback _callback)
                                                  throws ApiException
```
    Build call for setProcessInstanceVariableBinary
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    data - The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)
    
    valueType - The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - setProcessInstanceVariableBinary
```
public void setProcessInstanceVariableBinary(String id,
                                             String varName,
                                             File data,
                                             String valueType)
                                      throws ApiException
```
    Sets the serialized value for a binary variable or the binary value for a file variable.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    data - The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)
    
    valueType - The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setProcessInstanceVariableBinaryWithHttpInfo
```
public ApiResponse<Void> setProcessInstanceVariableBinaryWithHttpInfo(String id,
                                                                      String varName,
                                                                      File data,
                                                                      String valueType)
                                                               throws ApiException
```
    Sets the serialized value for a binary variable or the binary value for a file variable.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    data - The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)
    
    valueType - The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (optional)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setProcessInstanceVariableBinaryAsync
```
public okhttp3.Call setProcessInstanceVariableBinaryAsync(String id,
                                                          String varName,
                                                          File data,
                                                          String valueType,
                                                          ApiCallback<Void> _callback)
                                                   throws ApiException
```
    (asynchronously) Sets the serialized value for a binary variable or the binary value for a file variable.
    
    Parameters:
    
    id - The id of the process instance to retrieve the variable for. (required)
    
    varName - The name of the variable to retrieve. (required)
    
    data - The binary data to be set. For File variables, this multipart can contain the filename, binary value and MIME type of the file variable to be set Only the filename is mandatory. (optional)
    
    valueType - The name of the variable type. Either Bytes for a byte array variable or File for a file variable. (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
  - setRetriesByProcessCall
```
public okhttp3.Call setRetriesByProcessCall(SetJobRetriesByProcessDto setJobRetriesByProcessDto,
                                            ApiCallback _callback)
                                     throws ApiException
```
    Build call for setRetriesByProcess
    
    Parameters:
    
    setJobRetriesByProcessDto - Please note that if both processInstances and processInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `historicProcessInstanceQuery` (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - setRetriesByProcess
```
public BatchDto setRetriesByProcess(SetJobRetriesByProcessDto setJobRetriesByProcessDto)
                             throws ApiException
```
    Create a batch to set retries of jobs associated with given processes asynchronously.
    
    Parameters:
    
    setJobRetriesByProcessDto - Please note that if both processInstances and processInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `historicProcessInstanceQuery` (optional)
    
    Returns:
    
    BatchDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setRetriesByProcessWithHttpInfo
```
public ApiResponse<BatchDto> setRetriesByProcessWithHttpInfo(SetJobRetriesByProcessDto setJobRetriesByProcessDto)
                                                      throws ApiException
```
    Create a batch to set retries of jobs associated with given processes asynchronously.
    
    Parameters:
    
    setJobRetriesByProcessDto - Please note that if both processInstances and processInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `historicProcessInstanceQuery` (optional)
    
    Returns:
    
    ApiResponse<BatchDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setRetriesByProcessAsync
```
public okhttp3.Call setRetriesByProcessAsync(SetJobRetriesByProcessDto setJobRetriesByProcessDto,
                                             ApiCallback<BatchDto> _callback)
                                      throws ApiException
```
    (asynchronously) Create a batch to set retries of jobs associated with given processes asynchronously.
    
    Parameters:
    
    setJobRetriesByProcessDto - Please note that if both processInstances and processInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `historicProcessInstanceQuery` (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
  - setRetriesByProcessHistoricQueryBasedCall
```
public okhttp3.Call setRetriesByProcessHistoricQueryBasedCall(SetJobRetriesByProcessDto setJobRetriesByProcessDto,
                                                              ApiCallback _callback)
                                                       throws ApiException
```
    Build call for setRetriesByProcessHistoricQueryBased
    
    Parameters:
    
    setJobRetriesByProcessDto - Please note that if both processInstances and historicProcessInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `processInstanceQuery` (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - setRetriesByProcessHistoricQueryBased
```
public BatchDto setRetriesByProcessHistoricQueryBased(SetJobRetriesByProcessDto setJobRetriesByProcessDto)
                                               throws ApiException
```
    Create a batch to set retries of jobs asynchronously based on a historic process instance query.
    
    Parameters:
    
    setJobRetriesByProcessDto - Please note that if both processInstances and historicProcessInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `processInstanceQuery` (optional)
    
    Returns:
    
    BatchDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setRetriesByProcessHistoricQueryBasedWithHttpInfo
```
public ApiResponse<BatchDto> setRetriesByProcessHistoricQueryBasedWithHttpInfo(SetJobRetriesByProcessDto setJobRetriesByProcessDto)
                                                                        throws ApiException
```
    Create a batch to set retries of jobs asynchronously based on a historic process instance query.
    
    Parameters:
    
    setJobRetriesByProcessDto - Please note that if both processInstances and historicProcessInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `processInstanceQuery` (optional)
    
    Returns:
    
    ApiResponse<BatchDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - setRetriesByProcessHistoricQueryBasedAsync
```
public okhttp3.Call setRetriesByProcessHistoricQueryBasedAsync(SetJobRetriesByProcessDto setJobRetriesByProcessDto,
                                                               ApiCallback<BatchDto> _callback)
                                                        throws ApiException
```
    (asynchronously) Create a batch to set retries of jobs asynchronously based on a historic process instance query.
    
    Parameters:
    
    setJobRetriesByProcessDto - Please note that if both processInstances and historicProcessInstanceQuery are provided, then the resulting execution will be performed on the union of these sets. **Unallowed property**: `processInstanceQuery` (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
  - updateSuspensionStateCall
```
public okhttp3.Call updateSuspensionStateCall(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto,
                                              ApiCallback _callback)
                                       throws ApiException
```
    Build call for updateSuspensionState
    
    Parameters:
    
    processInstanceSuspensionStateDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - updateSuspensionState
```
public void updateSuspensionState(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto)
                           throws ApiException
```
    Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery`
    
    Parameters:
    
    processInstanceSuspensionStateDto - (optional)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - updateSuspensionStateWithHttpInfo
```
public ApiResponse<Void> updateSuspensionStateWithHttpInfo(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto)
                                                    throws ApiException
```
    Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery`
    
    Parameters:
    
    processInstanceSuspensionStateDto - (optional)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - updateSuspensionStateAsync
```
public okhttp3.Call updateSuspensionStateAsync(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto,
                                               ApiCallback<Void> _callback)
                                        throws ApiException
```
    (asynchronously) Activates or suspends process instances by providing certain criteria: # Activate/Suspend Process Instance By Process Definition Id * `suspend` * `processDefinitionId` # Activate/Suspend Process Instance By Process Definition Key * `suspend` * `processDefinitionKey` * `processDefinitionTenantId` * `processDefinitionWithoutTenantId` # Activate/Suspend Process Instance In Group * `suspend` * `processInstanceIds` * `processInstanceQuery` * `historicProcessInstanceQuery`
    
    Parameters:
    
    processInstanceSuspensionStateDto - (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
  - updateSuspensionStateAsyncOperationCall
```
public okhttp3.Call updateSuspensionStateAsyncOperationCall(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto,
                                                            ApiCallback _callback)
                                                     throws ApiException
```
    Build call for updateSuspensionStateAsyncOperation
    
    Parameters:
    
    processInstanceSuspensionStateAsyncDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - updateSuspensionStateAsyncOperation
```
public BatchDto updateSuspensionStateAsyncOperation(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto)
                                             throws ApiException
```
    Activates or suspends process instances asynchronously with a list of process instance ids, a process instance query, and/or a historical process instance query.
    
    Parameters:
    
    processInstanceSuspensionStateAsyncDto - (optional)
    
    Returns:
    
    BatchDto
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - updateSuspensionStateAsyncOperationWithHttpInfo
```
public ApiResponse<BatchDto> updateSuspensionStateAsyncOperationWithHttpInfo(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto)
                                                                      throws ApiException
```
    Activates or suspends process instances asynchronously with a list of process instance ids, a process instance query, and/or a historical process instance query.
    
    Parameters:
    
    processInstanceSuspensionStateAsyncDto - (optional)
    
    Returns:
    
    ApiResponse<BatchDto>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - updateSuspensionStateAsyncOperationAsync
```
public okhttp3.Call updateSuspensionStateAsyncOperationAsync(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto,
                                                             ApiCallback<BatchDto> _callback)
                                                      throws ApiException
```
    (asynchronously) Activates or suspends process instances asynchronously with a list of process instance ids, a process instance query, and/or a historical process instance query.
    
    Parameters:
    
    processInstanceSuspensionStateAsyncDto - (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
  - updateSuspensionStateByIdCall
```
public okhttp3.Call updateSuspensionStateByIdCall(String id,
                                                  SuspensionStateDto suspensionStateDto,
                                                  ApiCallback _callback)
                                           throws ApiException
```
    Build call for updateSuspensionStateById
    
    Parameters:
    
    id - The id of the process instance to activate or suspend. (required)
    
    suspensionStateDto - (optional)
    
    _callback - Callback for upload/download progress
    
    Returns:
    
    Call to execute
    
    Throws:
    
    ApiException - If fail to serialize the request body object
  - updateSuspensionStateById
```
public void updateSuspensionStateById(String id,
                                      SuspensionStateDto suspensionStateDto)
                               throws ApiException
```
    Activates or suspends a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to activate or suspend. (required)
    
    suspensionStateDto - (optional)
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - updateSuspensionStateByIdWithHttpInfo
```
public ApiResponse<Void> updateSuspensionStateByIdWithHttpInfo(String id,
                                                               SuspensionStateDto suspensionStateDto)
                                                        throws ApiException
```
    Activates or suspends a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to activate or suspend. (required)
    
    suspensionStateDto - (optional)
    
    Returns:
    
    ApiResponse<Void>
    
    Throws:
    
    ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
  - updateSuspensionStateByIdAsync
```
public okhttp3.Call updateSuspensionStateByIdAsync(String id,
                                                   SuspensionStateDto suspensionStateDto,
                                                   ApiCallback<Void> _callback)
                                            throws ApiException
```
    (asynchronously) Activates or suspends a given process instance by id.
    
    Parameters:
    
    id - The id of the process instance to activate or suspend. (required)
    
    suspensionStateDto - (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

Class ProcessInstanceApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProcessInstanceApi

ProcessInstanceApi

Method Detail

getApiClient

setApiClient

deleteAsyncHistoricQueryBasedCall

deleteAsyncHistoricQueryBased

deleteAsyncHistoricQueryBasedWithHttpInfo

deleteAsyncHistoricQueryBasedAsync

deleteProcessInstanceCall

deleteProcessInstance

deleteProcessInstanceWithHttpInfo

deleteProcessInstanceAsync

deleteProcessInstanceVariableCall

deleteProcessInstanceVariable

deleteProcessInstanceVariableWithHttpInfo

deleteProcessInstanceVariableAsync

deleteProcessInstancesAsyncOperationCall

deleteProcessInstancesAsyncOperation

deleteProcessInstancesAsyncOperationWithHttpInfo

deleteProcessInstancesAsyncOperationAsync

getActivityInstanceTreeCall

getActivityInstanceTree

getActivityInstanceTreeWithHttpInfo

getActivityInstanceTreeAsync

getProcessInstanceCall

getProcessInstance

getProcessInstanceWithHttpInfo

getProcessInstanceAsync

getProcessInstanceVariableCall

getProcessInstanceVariable

getProcessInstanceVariableWithHttpInfo

getProcessInstanceVariableAsync

getProcessInstanceVariableBinaryCall

getProcessInstanceVariableBinary

getProcessInstanceVariableBinaryWithHttpInfo

getProcessInstanceVariableBinaryAsync

getProcessInstanceVariablesCall

getProcessInstanceVariables

getProcessInstanceVariablesWithHttpInfo

getProcessInstanceVariablesAsync

getProcessInstancesCall

getProcessInstances

getProcessInstancesWithHttpInfo

getProcessInstancesAsync

getProcessInstancesCountCall

getProcessInstancesCount

getProcessInstancesCountWithHttpInfo

getProcessInstancesCountAsync

modifyProcessInstanceCall

modifyProcessInstance

modifyProcessInstanceWithHttpInfo

modifyProcessInstanceAsync

modifyProcessInstanceAsyncOperationCall

modifyProcessInstanceAsyncOperation

modifyProcessInstanceAsyncOperationWithHttpInfo

modifyProcessInstanceAsyncOperationAsync

modifyProcessInstanceVariablesCall

modifyProcessInstanceVariables

modifyProcessInstanceVariablesWithHttpInfo

modifyProcessInstanceVariablesAsync

queryProcessInstancesCall

queryProcessInstances

queryProcessInstancesWithHttpInfo

queryProcessInstancesAsync

queryProcessInstancesCountCall

queryProcessInstancesCount

queryProcessInstancesCountWithHttpInfo

queryProcessInstancesCountAsync

setProcessInstanceVariableCall

setProcessInstanceVariable

setProcessInstanceVariableWithHttpInfo

setProcessInstanceVariableAsync

setProcessInstanceVariableBinaryCall

setProcessInstanceVariableBinary