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

Class ProcessInstanceApi

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

  • Constructor Details

    • ProcessInstanceApi

      public ProcessInstanceApi()

    • ProcessInstanceApi

      public ProcessInstanceApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • correlateMessageAsyncOperation

      public BatchDto correlateMessageAsyncOperation(CorrelationMessageAsyncDto correlationMessageAsyncDto) throws ApiException
      Correlate Message Async (POST) Correlates a message asynchronously to executions that are waiting for this message. Messages will not be correlated to process definition-level start message events to start process instances.
      Parameters:
      correlationMessageAsyncDto - (optional)
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • correlateMessageAsyncOperation

      public BatchDto correlateMessageAsyncOperation(CorrelationMessageAsyncDto correlationMessageAsyncDto, Map<String,String> additionalHeaders) throws ApiException
      Correlate Message Async (POST) Correlates a message asynchronously to executions that are waiting for this message. Messages will not be correlated to process definition-level start message events to start process instances.
      Parameters:
      correlationMessageAsyncDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • deleteAsyncHistoricQueryBased

      public BatchDto deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto deleteProcessInstancesDto) throws ApiException
      Delete Async Historic Query Based (POST) 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 fails to make API call

    • deleteAsyncHistoricQueryBased

      public BatchDto deleteAsyncHistoricQueryBased(DeleteProcessInstancesDto deleteProcessInstancesDto, Map<String,String> additionalHeaders) throws ApiException
      Delete Async Historic Query Based (POST) Deletes a set of process instances asynchronously (batch) based on a historic process instance query.
      Parameters:
      deleteProcessInstancesDto - **Unallowed property**: `processInstanceQuery` (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • deleteProcessInstance

      public void deleteProcessInstance(String id, Boolean skipCustomListeners, Boolean skipIoMappings, Boolean skipSubprocesses, Boolean failIfNotExists) throws ApiException
      Delete 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 fails to make API call

    • deleteProcessInstance

      public void deleteProcessInstance(String id, Boolean skipCustomListeners, Boolean skipIoMappings, Boolean skipSubprocesses, Boolean failIfNotExists, Map<String,String> additionalHeaders) throws ApiException
      Delete 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteProcessInstanceVariable

      public void deleteProcessInstanceVariable(String id, String varName) throws ApiException
      Delete Process Variable 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 fails to make API call

    • deleteProcessInstanceVariable

      public void deleteProcessInstanceVariable(String id, String varName, Map<String,String> additionalHeaders) throws ApiException
      Delete Process Variable 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteProcessInstancesAsyncOperation

      public BatchDto deleteProcessInstancesAsyncOperation(DeleteProcessInstancesDto deleteProcessInstancesDto) throws ApiException
      Delete Async (POST) Deletes multiple process instances asynchronously (batch).
      Parameters:
      deleteProcessInstancesDto - **Unallowed property**: `historicProcessInstanceQuery` (optional)
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • deleteProcessInstancesAsyncOperation

      public BatchDto deleteProcessInstancesAsyncOperation(DeleteProcessInstancesDto deleteProcessInstancesDto, Map<String,String> additionalHeaders) throws ApiException
      Delete Async (POST) Deletes multiple process instances asynchronously (batch).
      Parameters:
      deleteProcessInstancesDto - **Unallowed property**: `historicProcessInstanceQuery` (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • getActivityInstanceTree

      public ActivityInstanceDto getActivityInstanceTree(String id) throws ApiException
      Get Activity Instance 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 fails to make API call

    • getActivityInstanceTree

      public ActivityInstanceDto getActivityInstanceTree(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Activity Instance 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ActivityInstanceDto
      Throws:
      ApiException - if fails to make API call

    • 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 fails to make API call

    • getProcessInstance

      public ProcessInstanceDto getProcessInstance(String id, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ProcessInstanceDto
      Throws:
      ApiException - if fails to make API call

    • getProcessInstanceComments

      public List<CommentDto> getProcessInstanceComments(String id) throws ApiException
      Get Process Instance Comments Gets the comments for a process instance by id.
      Parameters:
      id - The id of the process instance to retrieve the comments for. (required)
      Returns:
      List<CommentDto>
      Throws:
      ApiException - if fails to make API call

    • getProcessInstanceComments

      public List<CommentDto> getProcessInstanceComments(String id, Map<String,String> additionalHeaders) throws ApiException
      Get Process Instance Comments Gets the comments for a process instance by id.
      Parameters:
      id - The id of the process instance to retrieve the comments for. (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<CommentDto>
      Throws:
      ApiException - if fails to make API call

    • getProcessInstanceVariable

      public VariableValueDto getProcessInstanceVariable(String id, String varName, Boolean deserializeValue) throws ApiException
      Get Process Variable 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 fails to make API call

    • getProcessInstanceVariable

      public VariableValueDto getProcessInstanceVariable(String id, String varName, Boolean deserializeValue, Map<String,String> additionalHeaders) throws ApiException
      Get Process Variable 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      VariableValueDto
      Throws:
      ApiException - if fails to make API call

    • getProcessInstanceVariableBinary

      public File getProcessInstanceVariableBinary(String id, String varName) throws ApiException
      Get Process Variable (Binary) 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 fails to make API call

    • getProcessInstanceVariableBinary

      public File getProcessInstanceVariableBinary(String id, String varName, Map<String,String> additionalHeaders) throws ApiException
      Get Process Variable (Binary) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      File
      Throws:
      ApiException - if fails to make API call

    • getProcessInstanceVariables

      public Map<String,VariableValueDto> getProcessInstanceVariables(String id, Boolean deserializeValues) throws ApiException
      Get Process Variables Retrieves all variables of a given process instance by id.
      Parameters:
      id - The id of the process instance to retrieve the variables from. (required)
      deserializeValues - 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 fails to make API call

    • getProcessInstanceVariables

      public Map<String,VariableValueDto> getProcessInstanceVariables(String id, Boolean deserializeValues, Map<String,String> additionalHeaders) throws ApiException
      Get Process Variables Retrieves all variables of a given process instance by id.
      Parameters:
      id - The id of the process instance to retrieve the variables from. (required)
      deserializeValues - 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Map<String, VariableValueDto>
      Throws:
      ApiException - if fails to make API call

    • 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
      Get List 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.21/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 fails to make API call

    • 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, Map<String,String> additionalHeaders) throws ApiException
      Get List 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<ProcessInstanceDto>
      Throws:
      ApiException - if fails to make API call

    • 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
      Get List Count 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.21/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 fails to make API call

    • 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, Map<String,String> additionalHeaders) throws ApiException
      Get List Count 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • modifyProcessInstance

      public void modifyProcessInstance(String id, ProcessInstanceModificationDto processInstanceModificationDto) throws ApiException
      Modify Process Instance Execution State 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 fails to make API call

    • modifyProcessInstance

      public void modifyProcessInstance(String id, ProcessInstanceModificationDto processInstanceModificationDto, Map<String,String> additionalHeaders) throws ApiException
      Modify Process Instance Execution State 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • modifyProcessInstanceAsyncOperation

      public BatchDto modifyProcessInstanceAsyncOperation(String id, ProcessInstanceModificationDto processInstanceModificationDto) throws ApiException
      Modify Process Instance Execution State Async 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.21/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 fails to make API call

    • modifyProcessInstanceAsyncOperation

      public BatchDto modifyProcessInstanceAsyncOperation(String id, ProcessInstanceModificationDto processInstanceModificationDto, Map<String,String> additionalHeaders) throws ApiException
      Modify Process Instance Execution State Async 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.21/user-guide/process-engine/process-instance-modification/).
      Parameters:
      id - The id of the process instance to modify. (required)
      processInstanceModificationDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • modifyProcessInstanceVariables

      public void modifyProcessInstanceVariables(String id, PatchVariablesDto patchVariablesDto) throws ApiException
      Update/Delete Process Variables 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 fails to make API call

    • modifyProcessInstanceVariables

      public void modifyProcessInstanceVariables(String id, PatchVariablesDto patchVariablesDto, Map<String,String> additionalHeaders) throws ApiException
      Update/Delete Process Variables 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • queryProcessInstances

      public List<ProcessInstanceDto> queryProcessInstances(Integer firstResult, Integer maxResults, ProcessInstanceQueryDto processInstanceQueryDto) throws ApiException
      Get List (POST) 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 fails to make API call

    • queryProcessInstances

      public List<ProcessInstanceDto> queryProcessInstances(Integer firstResult, Integer maxResults, ProcessInstanceQueryDto processInstanceQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get List (POST) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<ProcessInstanceDto>
      Throws:
      ApiException - if fails to make API call

    • queryProcessInstancesCount

      public CountResultDto queryProcessInstancesCount(ProcessInstanceQueryDto processInstanceQueryDto) throws ApiException
      Get List Count (POST) 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 fails to make API call

    • queryProcessInstancesCount

      public CountResultDto queryProcessInstancesCount(ProcessInstanceQueryDto processInstanceQueryDto, Map<String,String> additionalHeaders) throws ApiException
      Get List Count (POST) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • setProcessInstanceVariable

      public void setProcessInstanceVariable(String id, String varName, VariableValueDto variableValueDto) throws ApiException
      Update Process Variable 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 fails to make API call

    • setProcessInstanceVariable

      public void setProcessInstanceVariable(String id, String varName, VariableValueDto variableValueDto, Map<String,String> additionalHeaders) throws ApiException
      Update Process Variable 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • setProcessInstanceVariableBinary

      public void setProcessInstanceVariableBinary(String id, String varName, File data, String valueType) throws ApiException
      Update Process Variable (Binary) 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 fails to make API call

    • setProcessInstanceVariableBinary

      public void setProcessInstanceVariableBinary(String id, String varName, File data, String valueType, Map<String,String> additionalHeaders) throws ApiException
      Update Process Variable (Binary) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • setRetriesByProcess

      public BatchDto setRetriesByProcess(SetJobRetriesByProcessDto setJobRetriesByProcessDto) throws ApiException
      Set Job Retries Async (POST) 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 fails to make API call

    • setRetriesByProcess

      public BatchDto setRetriesByProcess(SetJobRetriesByProcessDto setJobRetriesByProcessDto, Map<String,String> additionalHeaders) throws ApiException
      Set Job Retries Async (POST) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • setRetriesByProcessHistoricQueryBased

      public BatchDto setRetriesByProcessHistoricQueryBased(SetJobRetriesByProcessDto setJobRetriesByProcessDto) throws ApiException
      Set Job Retries Async Historic Query Based (POST) 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 fails to make API call

    • setRetriesByProcessHistoricQueryBased

      public BatchDto setRetriesByProcessHistoricQueryBased(SetJobRetriesByProcessDto setJobRetriesByProcessDto, Map<String,String> additionalHeaders) throws ApiException
      Set Job Retries Async Historic Query Based (POST) 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • setVariablesAsyncOperation

      public BatchDto setVariablesAsyncOperation(SetVariablesAsyncDto setVariablesAsyncDto) throws ApiException
      Set Variables Async (POST) Update or create runtime process variables in the root scope of process instances.
      Parameters:
      setVariablesAsyncDto - (optional)
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • setVariablesAsyncOperation

      public BatchDto setVariablesAsyncOperation(SetVariablesAsyncDto setVariablesAsyncDto, Map<String,String> additionalHeaders) throws ApiException
      Set Variables Async (POST) Update or create runtime process variables in the root scope of process instances.
      Parameters:
      setVariablesAsyncDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • updateSuspensionState

      public void updateSuspensionState(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto) throws ApiException
      Activate/Suspend In Group 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 fails to make API call

    • updateSuspensionState

      public void updateSuspensionState(ProcessInstanceSuspensionStateDto processInstanceSuspensionStateDto, Map<String,String> additionalHeaders) throws ApiException
      Activate/Suspend In Group 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • updateSuspensionStateAsyncOperation

      public BatchDto updateSuspensionStateAsyncOperation(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto) throws ApiException
      Activate/Suspend In Batch 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 fails to make API call

    • updateSuspensionStateAsyncOperation

      public BatchDto updateSuspensionStateAsyncOperation(ProcessInstanceSuspensionStateAsyncDto processInstanceSuspensionStateAsyncDto, Map<String,String> additionalHeaders) throws ApiException
      Activate/Suspend In Batch 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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      BatchDto
      Throws:
      ApiException - if fails to make API call

    • updateSuspensionStateById

      public void updateSuspensionStateById(String id, SuspensionStateDto suspensionStateDto) throws ApiException
      Activate/Suspend Process Instance By Id 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 fails to make API call

    • updateSuspensionStateById

      public void updateSuspensionStateById(String id, SuspensionStateDto suspensionStateDto, Map<String,String> additionalHeaders) throws ApiException
      Activate/Suspend Process Instance By Id Activates or suspends a given process instance by id.
      Parameters:
      id - The id of the process instance to activate or suspend. (required)
      suspensionStateDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call