Package org.openapitools.client.api

Class ExecutionApi

  • public class ExecutionApi
extends Object

    • Constructor Detail

      • ExecutionApi

        public ExecutionApi()

      • ExecutionApi

        public ExecutionApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • createIncidentCall

        public okhttp3.Call createIncidentCall​(String id,
                                       CreateIncidentDto createIncidentDto,
                                       ApiCallback _callback)
                                throws ApiException
        Build call for createIncident
        Parameters:
        id - The id of the execution to create a new incident for. (required)
        createIncidentDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • createIncident

        public IncidentDto createIncident​(String id,
                                  CreateIncidentDto createIncidentDto)
                           throws ApiException
        Create Incident Creates a custom incident with given properties.
        Parameters:
        id - The id of the execution to create a new incident for. (required)
        createIncidentDto - (optional)
        Returns:
        IncidentDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createIncidentWithHttpInfo

        public ApiResponse<IncidentDto> createIncidentWithHttpInfo​(String id,
                                                           CreateIncidentDto createIncidentDto)
                                                    throws ApiException
        Create Incident Creates a custom incident with given properties.
        Parameters:
        id - The id of the execution to create a new incident for. (required)
        createIncidentDto - (optional)
        Returns:
        ApiResponse<IncidentDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • createIncidentAsync

        public okhttp3.Call createIncidentAsync​(String id,
                                        CreateIncidentDto createIncidentDto,
                                        ApiCallback<IncidentDto> _callback)
                                 throws ApiException
        Create Incident (asynchronously) Creates a custom incident with given properties.
        Parameters:
        id - The id of the execution to create a new incident for. (required)
        createIncidentDto - (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

      • deleteLocalExecutionVariableCall

        public okhttp3.Call deleteLocalExecutionVariableCall​(String id,
                                                     String varName,
                                                     ApiCallback _callback)
                                              throws ApiException
        Build call for deleteLocalExecutionVariable
        Parameters:
        id - The id of the execution 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

      • deleteLocalExecutionVariable

        public void deleteLocalExecutionVariable​(String id,
                                         String varName)
                                  throws ApiException
        Delete Local Execution Variable Deletes a variable in the context of a given execution by id. Deletion does not propagate upwards in the execution hierarchy.
        Parameters:
        id - The id of the execution 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

      • deleteLocalExecutionVariableWithHttpInfo

        public ApiResponse<Void> deleteLocalExecutionVariableWithHttpInfo​(String id,
                                                                  String varName)
                                                           throws ApiException
        Delete Local Execution Variable Deletes a variable in the context of a given execution by id. Deletion does not propagate upwards in the execution hierarchy.
        Parameters:
        id - The id of the execution 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

      • deleteLocalExecutionVariableAsync

        public okhttp3.Call deleteLocalExecutionVariableAsync​(String id,
                                                      String varName,
                                                      ApiCallback<Void> _callback)
                                               throws ApiException
        Delete Local Execution Variable (asynchronously) Deletes a variable in the context of a given execution by id. Deletion does not propagate upwards in the execution hierarchy.
        Parameters:
        id - The id of the execution 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

      • getExecutionCall

        public okhttp3.Call getExecutionCall​(String id,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for getExecution
        Parameters:
        id - The id of the execution to be retrieved. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExecution

        public ExecutionDto getExecution​(String id)
                          throws ApiException
        Get Execution Retrieves an execution by id, according to the `Execution` interface in the engine.
        Parameters:
        id - The id of the execution to be retrieved. (required)
        Returns:
        ExecutionDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExecutionWithHttpInfo

        public ApiResponse<ExecutionDto> getExecutionWithHttpInfo​(String id)
                                                   throws ApiException
        Get Execution Retrieves an execution by id, according to the `Execution` interface in the engine.
        Parameters:
        id - The id of the execution to be retrieved. (required)
        Returns:
        ApiResponse<ExecutionDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExecutionAsync

        public okhttp3.Call getExecutionAsync​(String id,
                                      ApiCallback<ExecutionDto> _callback)
                               throws ApiException
        Get Execution (asynchronously) Retrieves an execution by id, according to the `Execution` interface in the engine.
        Parameters:
        id - The id of the execution 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

      • getExecutionsCall

        public okhttp3.Call getExecutionsCall​(String businessKey,
                                      String processDefinitionId,
                                      String processDefinitionKey,
                                      String processInstanceId,
                                      String activityId,
                                      String signalEventSubscriptionName,
                                      String messageEventSubscriptionName,
                                      Boolean active,
                                      Boolean suspended,
                                      String incidentId,
                                      String incidentType,
                                      String incidentMessage,
                                      String incidentMessageLike,
                                      String tenantIdIn,
                                      String variables,
                                      String processVariables,
                                      Boolean variableNamesIgnoreCase,
                                      Boolean variableValuesIgnoreCase,
                                      String sortBy,
                                      String sortOrder,
                                      Integer firstResult,
                                      Integer maxResults,
                                      ApiCallback _callback)
                               throws ApiException
        Build call for getExecutions
        Parameters:
        businessKey - Filter by the business key of the process instances the executions belong to. (optional)
        processDefinitionId - Filter by the process definition the executions run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the executions run on. (optional)
        processInstanceId - Filter by the id of the process instance the execution belongs to. (optional)
        activityId - Filter by the id of the activity the execution currently executes. (optional)
        signalEventSubscriptionName - Select only those executions that expect a signal of the given name. (optional)
        messageEventSubscriptionName - Select only those executions that expect a message of the given name. (optional)
        active - Only include active executions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended executions. Value may only be `true`, as `false` is the default behavior. (optional)
        incidentId - Filter by the incident id. (optional)
        incidentType - Filter by the incident type. See the [User Guide](/manual/develop/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. An execution must have one of the given tenant ids. (optional)
        variables - Only include executions 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)
        processVariables - Only include executions that belong to a process instance with 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. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExecutions

        public List<ExecutionDto> getExecutions​(String businessKey,
                                        String processDefinitionId,
                                        String processDefinitionKey,
                                        String processInstanceId,
                                        String activityId,
                                        String signalEventSubscriptionName,
                                        String messageEventSubscriptionName,
                                        Boolean active,
                                        Boolean suspended,
                                        String incidentId,
                                        String incidentType,
                                        String incidentMessage,
                                        String incidentMessageLike,
                                        String tenantIdIn,
                                        String variables,
                                        String processVariables,
                                        Boolean variableNamesIgnoreCase,
                                        Boolean variableValuesIgnoreCase,
                                        String sortBy,
                                        String sortOrder,
                                        Integer firstResult,
                                        Integer maxResults)
                                 throws ApiException
        Get Executions Queries for the executions that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of executions. The size of the result set can be retrieved by using the [Get Execution Count](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query-count/) method.
        Parameters:
        businessKey - Filter by the business key of the process instances the executions belong to. (optional)
        processDefinitionId - Filter by the process definition the executions run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the executions run on. (optional)
        processInstanceId - Filter by the id of the process instance the execution belongs to. (optional)
        activityId - Filter by the id of the activity the execution currently executes. (optional)
        signalEventSubscriptionName - Select only those executions that expect a signal of the given name. (optional)
        messageEventSubscriptionName - Select only those executions that expect a message of the given name. (optional)
        active - Only include active executions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended executions. Value may only be `true`, as `false` is the default behavior. (optional)
        incidentId - Filter by the incident id. (optional)
        incidentType - Filter by the incident type. See the [User Guide](/manual/develop/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. An execution must have one of the given tenant ids. (optional)
        variables - Only include executions 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)
        processVariables - Only include executions that belong to a process instance with 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. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        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)
        Returns:
        List<ExecutionDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExecutionsWithHttpInfo

        public ApiResponse<List<ExecutionDto>> getExecutionsWithHttpInfo​(String businessKey,
                                                                 String processDefinitionId,
                                                                 String processDefinitionKey,
                                                                 String processInstanceId,
                                                                 String activityId,
                                                                 String signalEventSubscriptionName,
                                                                 String messageEventSubscriptionName,
                                                                 Boolean active,
                                                                 Boolean suspended,
                                                                 String incidentId,
                                                                 String incidentType,
                                                                 String incidentMessage,
                                                                 String incidentMessageLike,
                                                                 String tenantIdIn,
                                                                 String variables,
                                                                 String processVariables,
                                                                 Boolean variableNamesIgnoreCase,
                                                                 Boolean variableValuesIgnoreCase,
                                                                 String sortBy,
                                                                 String sortOrder,
                                                                 Integer firstResult,
                                                                 Integer maxResults)
                                                          throws ApiException
        Get Executions Queries for the executions that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of executions. The size of the result set can be retrieved by using the [Get Execution Count](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query-count/) method.
        Parameters:
        businessKey - Filter by the business key of the process instances the executions belong to. (optional)
        processDefinitionId - Filter by the process definition the executions run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the executions run on. (optional)
        processInstanceId - Filter by the id of the process instance the execution belongs to. (optional)
        activityId - Filter by the id of the activity the execution currently executes. (optional)
        signalEventSubscriptionName - Select only those executions that expect a signal of the given name. (optional)
        messageEventSubscriptionName - Select only those executions that expect a message of the given name. (optional)
        active - Only include active executions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended executions. Value may only be `true`, as `false` is the default behavior. (optional)
        incidentId - Filter by the incident id. (optional)
        incidentType - Filter by the incident type. See the [User Guide](/manual/develop/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. An execution must have one of the given tenant ids. (optional)
        variables - Only include executions 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)
        processVariables - Only include executions that belong to a process instance with 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. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        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)
        Returns:
        ApiResponse<List<ExecutionDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExecutionsAsync

        public okhttp3.Call getExecutionsAsync​(String businessKey,
                                       String processDefinitionId,
                                       String processDefinitionKey,
                                       String processInstanceId,
                                       String activityId,
                                       String signalEventSubscriptionName,
                                       String messageEventSubscriptionName,
                                       Boolean active,
                                       Boolean suspended,
                                       String incidentId,
                                       String incidentType,
                                       String incidentMessage,
                                       String incidentMessageLike,
                                       String tenantIdIn,
                                       String variables,
                                       String processVariables,
                                       Boolean variableNamesIgnoreCase,
                                       Boolean variableValuesIgnoreCase,
                                       String sortBy,
                                       String sortOrder,
                                       Integer firstResult,
                                       Integer maxResults,
                                       ApiCallback<List<ExecutionDto>> _callback)
                                throws ApiException
        Get Executions (asynchronously) Queries for the executions that fulfill given parameters. Parameters may be static as well as dynamic runtime properties of executions. The size of the result set can be retrieved by using the [Get Execution Count](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query-count/) method.
        Parameters:
        businessKey - Filter by the business key of the process instances the executions belong to. (optional)
        processDefinitionId - Filter by the process definition the executions run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the executions run on. (optional)
        processInstanceId - Filter by the id of the process instance the execution belongs to. (optional)
        activityId - Filter by the id of the activity the execution currently executes. (optional)
        signalEventSubscriptionName - Select only those executions that expect a signal of the given name. (optional)
        messageEventSubscriptionName - Select only those executions that expect a message of the given name. (optional)
        active - Only include active executions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended executions. Value may only be `true`, as `false` is the default behavior. (optional)
        incidentId - Filter by the incident id. (optional)
        incidentType - Filter by the incident type. See the [User Guide](/manual/develop/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. An execution must have one of the given tenant ids. (optional)
        variables - Only include executions 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)
        processVariables - Only include executions that belong to a process instance with 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. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        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)
        _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

      • getExecutionsCountCall

        public okhttp3.Call getExecutionsCountCall​(String businessKey,
                                           String processDefinitionId,
                                           String processDefinitionKey,
                                           String processInstanceId,
                                           String activityId,
                                           String signalEventSubscriptionName,
                                           String messageEventSubscriptionName,
                                           Boolean active,
                                           Boolean suspended,
                                           String incidentId,
                                           String incidentType,
                                           String incidentMessage,
                                           String incidentMessageLike,
                                           String tenantIdIn,
                                           String variables,
                                           String processVariables,
                                           Boolean variableNamesIgnoreCase,
                                           Boolean variableValuesIgnoreCase,
                                           ApiCallback _callback)
                                    throws ApiException
        Build call for getExecutionsCount
        Parameters:
        businessKey - Filter by the business key of the process instances the executions belong to. (optional)
        processDefinitionId - Filter by the process definition the executions run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the executions run on. (optional)
        processInstanceId - Filter by the id of the process instance the execution belongs to. (optional)
        activityId - Filter by the id of the activity the execution currently executes. (optional)
        signalEventSubscriptionName - Select only those executions that expect a signal of the given name. (optional)
        messageEventSubscriptionName - Select only those executions that expect a message of the given name. (optional)
        active - Only include active executions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended executions. Value may only be `true`, as `false` is the default behavior. (optional)
        incidentId - Filter by the incident id. (optional)
        incidentType - Filter by the incident type. See the [User Guide](/manual/develop/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. An execution must have one of the given tenant ids. (optional)
        variables - Only include executions 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)
        processVariables - Only include executions that belong to a process instance with 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. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getExecutionsCount

        public CountResultDto getExecutionsCount​(String businessKey,
                                         String processDefinitionId,
                                         String processDefinitionKey,
                                         String processInstanceId,
                                         String activityId,
                                         String signalEventSubscriptionName,
                                         String messageEventSubscriptionName,
                                         Boolean active,
                                         Boolean suspended,
                                         String incidentId,
                                         String incidentType,
                                         String incidentMessage,
                                         String incidentMessageLike,
                                         String tenantIdIn,
                                         String variables,
                                         String processVariables,
                                         Boolean variableNamesIgnoreCase,
                                         Boolean variableValuesIgnoreCase)
                                  throws ApiException
        Get Execution Count Queries for the number of executions that fulfill given parameters. Takes the same parameters as the [Get Executions](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query/) method.
        Parameters:
        businessKey - Filter by the business key of the process instances the executions belong to. (optional)
        processDefinitionId - Filter by the process definition the executions run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the executions run on. (optional)
        processInstanceId - Filter by the id of the process instance the execution belongs to. (optional)
        activityId - Filter by the id of the activity the execution currently executes. (optional)
        signalEventSubscriptionName - Select only those executions that expect a signal of the given name. (optional)
        messageEventSubscriptionName - Select only those executions that expect a message of the given name. (optional)
        active - Only include active executions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended executions. Value may only be `true`, as `false` is the default behavior. (optional)
        incidentId - Filter by the incident id. (optional)
        incidentType - Filter by the incident type. See the [User Guide](/manual/develop/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. An execution must have one of the given tenant ids. (optional)
        variables - Only include executions 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)
        processVariables - Only include executions that belong to a process instance with 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. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExecutionsCountWithHttpInfo

        public ApiResponse<CountResultDto> getExecutionsCountWithHttpInfo​(String businessKey,
                                                                  String processDefinitionId,
                                                                  String processDefinitionKey,
                                                                  String processInstanceId,
                                                                  String activityId,
                                                                  String signalEventSubscriptionName,
                                                                  String messageEventSubscriptionName,
                                                                  Boolean active,
                                                                  Boolean suspended,
                                                                  String incidentId,
                                                                  String incidentType,
                                                                  String incidentMessage,
                                                                  String incidentMessageLike,
                                                                  String tenantIdIn,
                                                                  String variables,
                                                                  String processVariables,
                                                                  Boolean variableNamesIgnoreCase,
                                                                  Boolean variableValuesIgnoreCase)
                                                           throws ApiException
        Get Execution Count Queries for the number of executions that fulfill given parameters. Takes the same parameters as the [Get Executions](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query/) method.
        Parameters:
        businessKey - Filter by the business key of the process instances the executions belong to. (optional)
        processDefinitionId - Filter by the process definition the executions run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the executions run on. (optional)
        processInstanceId - Filter by the id of the process instance the execution belongs to. (optional)
        activityId - Filter by the id of the activity the execution currently executes. (optional)
        signalEventSubscriptionName - Select only those executions that expect a signal of the given name. (optional)
        messageEventSubscriptionName - Select only those executions that expect a message of the given name. (optional)
        active - Only include active executions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended executions. Value may only be `true`, as `false` is the default behavior. (optional)
        incidentId - Filter by the incident id. (optional)
        incidentType - Filter by the incident type. See the [User Guide](/manual/develop/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. An execution must have one of the given tenant ids. (optional)
        variables - Only include executions 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)
        processVariables - Only include executions that belong to a process instance with 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. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getExecutionsCountAsync

        public okhttp3.Call getExecutionsCountAsync​(String businessKey,
                                            String processDefinitionId,
                                            String processDefinitionKey,
                                            String processInstanceId,
                                            String activityId,
                                            String signalEventSubscriptionName,
                                            String messageEventSubscriptionName,
                                            Boolean active,
                                            Boolean suspended,
                                            String incidentId,
                                            String incidentType,
                                            String incidentMessage,
                                            String incidentMessageLike,
                                            String tenantIdIn,
                                            String variables,
                                            String processVariables,
                                            Boolean variableNamesIgnoreCase,
                                            Boolean variableValuesIgnoreCase,
                                            ApiCallback<CountResultDto> _callback)
                                     throws ApiException
        Get Execution Count (asynchronously) Queries for the number of executions that fulfill given parameters. Takes the same parameters as the [Get Executions](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query/) method.
        Parameters:
        businessKey - Filter by the business key of the process instances the executions belong to. (optional)
        processDefinitionId - Filter by the process definition the executions run on. (optional)
        processDefinitionKey - Filter by the key of the process definition the executions run on. (optional)
        processInstanceId - Filter by the id of the process instance the execution belongs to. (optional)
        activityId - Filter by the id of the activity the execution currently executes. (optional)
        signalEventSubscriptionName - Select only those executions that expect a signal of the given name. (optional)
        messageEventSubscriptionName - Select only those executions that expect a message of the given name. (optional)
        active - Only include active executions. Value may only be `true`, as `false` is the default behavior. (optional)
        suspended - Only include suspended executions. Value may only be `true`, as `false` is the default behavior. (optional)
        incidentId - Filter by the incident id. (optional)
        incidentType - Filter by the incident type. See the [User Guide](/manual/develop/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. An execution must have one of the given tenant ids. (optional)
        variables - Only include executions 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)
        processVariables - Only include executions that belong to a process instance with 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. `key` and `value` may not contain underscore or comma characters. (optional)
        variableNamesIgnoreCase - Match all variable names provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableName** and **variablename** are treated as equal. (optional)
        variableValuesIgnoreCase - Match all variable values provided in `variables` and `processVariables` case- insensitively. If set to `true` **variableValue** and **variablevalue** are treated as equal. (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

      • getLocalExecutionVariableCall

        public okhttp3.Call getLocalExecutionVariableCall​(String id,
                                                  String varName,
                                                  Boolean deserializeValue,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for getLocalExecutionVariable
        Parameters:
        id - The id of the execution to retrieve the variable from. (required)
        varName - The name of the variable to get. (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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getLocalExecutionVariable

        public VariableValueDto getLocalExecutionVariable​(String id,
                                                  String varName,
                                                  Boolean deserializeValue)
                                           throws ApiException
        Get Local Execution Variable Retrieves a variable from the context of a given execution by id. Does not traverse the parent execution hierarchy.
        Parameters:
        id - The id of the execution to retrieve the variable from. (required)
        varName - The name of the variable to get. (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)
        Returns:
        VariableValueDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLocalExecutionVariableWithHttpInfo

        public ApiResponse<VariableValueDto> getLocalExecutionVariableWithHttpInfo​(String id,
                                                                           String varName,
                                                                           Boolean deserializeValue)
                                                                    throws ApiException
        Get Local Execution Variable Retrieves a variable from the context of a given execution by id. Does not traverse the parent execution hierarchy.
        Parameters:
        id - The id of the execution to retrieve the variable from. (required)
        varName - The name of the variable to get. (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)
        Returns:
        ApiResponse<VariableValueDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLocalExecutionVariableAsync

        public okhttp3.Call getLocalExecutionVariableAsync​(String id,
                                                   String varName,
                                                   Boolean deserializeValue,
                                                   ApiCallback<VariableValueDto> _callback)
                                            throws ApiException
        Get Local Execution Variable (asynchronously) Retrieves a variable from the context of a given execution by id. Does not traverse the parent execution hierarchy.
        Parameters:
        id - The id of the execution to retrieve the variable from. (required)
        varName - The name of the variable to get. (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)
        _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

      • getLocalExecutionVariableBinaryCall

        public okhttp3.Call getLocalExecutionVariableBinaryCall​(String id,
                                                        String varName,
                                                        ApiCallback _callback)
                                                 throws ApiException
        Build call for getLocalExecutionVariableBinary
        Parameters:
        id - The id of the execution to retrieve the variable from. (required)
        varName - The name of the variable to get. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getLocalExecutionVariableBinary

        public File getLocalExecutionVariableBinary​(String id,
                                            String varName)
                                     throws ApiException
        Get Local Execution Variable (Binary) Retrieves a binary variable from the context of a given execution by id. Does not traverse the parent execution hierarchy. Applicable for byte array and file variables.
        Parameters:
        id - The id of the execution to retrieve the variable from. (required)
        varName - The name of the variable to get. (required)
        Returns:
        File
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLocalExecutionVariableBinaryWithHttpInfo

        public ApiResponse<File> getLocalExecutionVariableBinaryWithHttpInfo​(String id,
                                                                     String varName)
                                                              throws ApiException
        Get Local Execution Variable (Binary) Retrieves a binary variable from the context of a given execution by id. Does not traverse the parent execution hierarchy. Applicable for byte array and file variables.
        Parameters:
        id - The id of the execution to retrieve the variable from. (required)
        varName - The name of the variable to get. (required)
        Returns:
        ApiResponse<File>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLocalExecutionVariableBinaryAsync

        public okhttp3.Call getLocalExecutionVariableBinaryAsync​(String id,
                                                         String varName,
                                                         ApiCallback<File> _callback)
                                                  throws ApiException
        Get Local Execution Variable (Binary) (asynchronously) Retrieves a binary variable from the context of a given execution by id. Does not traverse the parent execution hierarchy. Applicable for byte array and file variables.
        Parameters:
        id - The id of the execution to retrieve the variable from. (required)
        varName - The name of the variable to get. (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

      • getLocalExecutionVariablesCall

        public okhttp3.Call getLocalExecutionVariablesCall​(String id,
                                                   Boolean deserializeValues,
                                                   ApiCallback _callback)
                                            throws ApiException
        Build call for getLocalExecutionVariables
        Parameters:
        id - The id of the execution 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)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getLocalExecutionVariables

        public Map<String,​VariableValueDto> getLocalExecutionVariables​(String id,
                                                                     Boolean deserializeValues)
                                                              throws ApiException
        Get Local Execution Variables Retrieves all variables of a given execution by id.
        Parameters:
        id - The id of the execution 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)
        Returns:
        Map<String, VariableValueDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLocalExecutionVariablesWithHttpInfo

        public ApiResponse<Map<String,​VariableValueDto>> getLocalExecutionVariablesWithHttpInfo​(String id,
                                                                                              Boolean deserializeValues)
                                                                                       throws ApiException
        Get Local Execution Variables Retrieves all variables of a given execution by id.
        Parameters:
        id - The id of the execution 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)
        Returns:
        ApiResponse<Map<String, VariableValueDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getLocalExecutionVariablesAsync

        public okhttp3.Call getLocalExecutionVariablesAsync​(String id,
                                                    Boolean deserializeValues,
                                                    ApiCallback<Map<String,​VariableValueDto>> _callback)
                                             throws ApiException
        Get Local Execution Variables (asynchronously) Retrieves all variables of a given execution by id.
        Parameters:
        id - The id of the execution 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)
        _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

      • getMessageEventSubscriptionCall

        public okhttp3.Call getMessageEventSubscriptionCall​(String id,
                                                    String messageName,
                                                    ApiCallback _callback)
                                             throws ApiException
        Build call for getMessageEventSubscription
        Parameters:
        id - The id of the execution that holds the subscription. (required)
        messageName - The name of the message that the subscription corresponds to. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • getMessageEventSubscription

        public EventSubscriptionDto getMessageEventSubscription​(String id,
                                                        String messageName)
                                                 throws ApiException
        Get Message Event Subscription Retrieves a message event subscription for a given execution by id and a message name.
        Parameters:
        id - The id of the execution that holds the subscription. (required)
        messageName - The name of the message that the subscription corresponds to. (required)
        Returns:
        EventSubscriptionDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMessageEventSubscriptionWithHttpInfo

        public ApiResponse<EventSubscriptionDto> getMessageEventSubscriptionWithHttpInfo​(String id,
                                                                                 String messageName)
                                                                          throws ApiException
        Get Message Event Subscription Retrieves a message event subscription for a given execution by id and a message name.
        Parameters:
        id - The id of the execution that holds the subscription. (required)
        messageName - The name of the message that the subscription corresponds to. (required)
        Returns:
        ApiResponse<EventSubscriptionDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • getMessageEventSubscriptionAsync

        public okhttp3.Call getMessageEventSubscriptionAsync​(String id,
                                                     String messageName,
                                                     ApiCallback<EventSubscriptionDto> _callback)
                                              throws ApiException
        Get Message Event Subscription (asynchronously) Retrieves a message event subscription for a given execution by id and a message name.
        Parameters:
        id - The id of the execution that holds the subscription. (required)
        messageName - The name of the message that the subscription corresponds to. (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

      • modifyLocalExecutionVariablesCall

        public okhttp3.Call modifyLocalExecutionVariablesCall​(String id,
                                                      PatchVariablesDto patchVariablesDto,
                                                      ApiCallback _callback)
                                               throws ApiException
        Build call for modifyLocalExecutionVariables
        Parameters:
        id - The id of the execution 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

      • modifyLocalExecutionVariables

        public void modifyLocalExecutionVariables​(String id,
                                          PatchVariablesDto patchVariablesDto)
                                   throws ApiException
        Update/Delete Local Execution Variables Updates or deletes the variables in the context of an execution by id. The updates do not propagate upwards in the execution hierarchy. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
        Parameters:
        id - The id of the execution 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

      • modifyLocalExecutionVariablesWithHttpInfo

        public ApiResponse<Void> modifyLocalExecutionVariablesWithHttpInfo​(String id,
                                                                   PatchVariablesDto patchVariablesDto)
                                                            throws ApiException
        Update/Delete Local Execution Variables Updates or deletes the variables in the context of an execution by id. The updates do not propagate upwards in the execution hierarchy. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
        Parameters:
        id - The id of the execution 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

      • modifyLocalExecutionVariablesAsync

        public okhttp3.Call modifyLocalExecutionVariablesAsync​(String id,
                                                       PatchVariablesDto patchVariablesDto,
                                                       ApiCallback<Void> _callback)
                                                throws ApiException
        Update/Delete Local Execution Variables (asynchronously) Updates or deletes the variables in the context of an execution by id. The updates do not propagate upwards in the execution hierarchy. Updates precede deletions. So, if a variable is updated AND deleted, the deletion overrides the update.
        Parameters:
        id - The id of the execution 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

      • putLocalExecutionVariableCall

        public okhttp3.Call putLocalExecutionVariableCall​(String id,
                                                  String varName,
                                                  VariableValueDto variableValueDto,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for putLocalExecutionVariable
        Parameters:
        id - The id of the execution 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

      • putLocalExecutionVariable

        public void putLocalExecutionVariable​(String id,
                                      String varName,
                                      VariableValueDto variableValueDto)
                               throws ApiException
        Put Local Execution Variable Sets a variable in the context of a given execution by id. Update does not propagate upwards in the execution hierarchy.
        Parameters:
        id - The id of the execution 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

      • putLocalExecutionVariableWithHttpInfo

        public ApiResponse<Void> putLocalExecutionVariableWithHttpInfo​(String id,
                                                               String varName,
                                                               VariableValueDto variableValueDto)
                                                        throws ApiException
        Put Local Execution Variable Sets a variable in the context of a given execution by id. Update does not propagate upwards in the execution hierarchy.
        Parameters:
        id - The id of the execution 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

      • putLocalExecutionVariableAsync

        public okhttp3.Call putLocalExecutionVariableAsync​(String id,
                                                   String varName,
                                                   VariableValueDto variableValueDto,
                                                   ApiCallback<Void> _callback)
                                            throws ApiException
        Put Local Execution Variable (asynchronously) Sets a variable in the context of a given execution by id. Update does not propagate upwards in the execution hierarchy.
        Parameters:
        id - The id of the execution 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

      • queryExecutionsCall

        public okhttp3.Call queryExecutionsCall​(Integer firstResult,
                                        Integer maxResults,
                                        ExecutionQueryDto executionQueryDto,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for queryExecutions
        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)
        executionQueryDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • queryExecutions

        public List<ExecutionDto> queryExecutions​(Integer firstResult,
                                          Integer maxResults,
                                          ExecutionQueryDto executionQueryDto)
                                   throws ApiException
        Get Executions (POST) Queries for executions that fulfill given parameters through a JSON object. This method is slightly more powerful than the [Get Executions](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query/) method because it allows to filter by multiple instance and execution 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)
        executionQueryDto - (optional)
        Returns:
        List<ExecutionDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryExecutionsWithHttpInfo

        public ApiResponse<List<ExecutionDto>> queryExecutionsWithHttpInfo​(Integer firstResult,
                                                                   Integer maxResults,
                                                                   ExecutionQueryDto executionQueryDto)
                                                            throws ApiException
        Get Executions (POST) Queries for executions that fulfill given parameters through a JSON object. This method is slightly more powerful than the [Get Executions](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query/) method because it allows to filter by multiple instance and execution 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)
        executionQueryDto - (optional)
        Returns:
        ApiResponse<List<ExecutionDto>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryExecutionsAsync

        public okhttp3.Call queryExecutionsAsync​(Integer firstResult,
                                         Integer maxResults,
                                         ExecutionQueryDto executionQueryDto,
                                         ApiCallback<List<ExecutionDto>> _callback)
                                  throws ApiException
        Get Executions (POST) (asynchronously) Queries for executions that fulfill given parameters through a JSON object. This method is slightly more powerful than the [Get Executions](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query/) method because it allows to filter by multiple instance and execution 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)
        executionQueryDto - (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

      • queryExecutionsCountCall

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

      • queryExecutionsCount

        public CountResultDto queryExecutionsCount​(ExecutionQueryDto executionQueryDto)
                                    throws ApiException
        Get Execution Count (POST) Queries for the number of executions that fulfill given parameters. This method takes the same message body as the [Get Executions POST](https://docs.camunda.org/manual/7.18/reference/rest/execution/post-query/) method and therefore it is slightly more powerful than the [Get Execution Count](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query-count/) method.
        Parameters:
        executionQueryDto - (optional)
        Returns:
        CountResultDto
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryExecutionsCountWithHttpInfo

        public ApiResponse<CountResultDto> queryExecutionsCountWithHttpInfo​(ExecutionQueryDto executionQueryDto)
                                                             throws ApiException
        Get Execution Count (POST) Queries for the number of executions that fulfill given parameters. This method takes the same message body as the [Get Executions POST](https://docs.camunda.org/manual/7.18/reference/rest/execution/post-query/) method and therefore it is slightly more powerful than the [Get Execution Count](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query-count/) method.
        Parameters:
        executionQueryDto - (optional)
        Returns:
        ApiResponse<CountResultDto>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • queryExecutionsCountAsync

        public okhttp3.Call queryExecutionsCountAsync​(ExecutionQueryDto executionQueryDto,
                                              ApiCallback<CountResultDto> _callback)
                                       throws ApiException
        Get Execution Count (POST) (asynchronously) Queries for the number of executions that fulfill given parameters. This method takes the same message body as the [Get Executions POST](https://docs.camunda.org/manual/7.18/reference/rest/execution/post-query/) method and therefore it is slightly more powerful than the [Get Execution Count](https://docs.camunda.org/manual/7.18/reference/rest/execution/get-query-count/) method.
        Parameters:
        executionQueryDto - (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

      • setLocalExecutionVariableBinaryCall

        public okhttp3.Call setLocalExecutionVariableBinaryCall​(String id,
                                                        String varName,
                                                        File data,
                                                        String valueType,
                                                        ApiCallback _callback)
                                                 throws ApiException
        Build call for setLocalExecutionVariableBinary
        Parameters:
        id - The id of the execution to set the variable for. (required)
        varName - The name of the variable to set. (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

      • setLocalExecutionVariableBinary

        public void setLocalExecutionVariableBinary​(String id,
                                            String varName,
                                            File data,
                                            String valueType)
                                     throws ApiException
        Post Local Execution Variable (Binary) Sets the serialized value for a binary variable or the binary value for a file variable in the context of a given execution by id.
        Parameters:
        id - The id of the execution to set the variable for. (required)
        varName - The name of the variable to set. (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

      • setLocalExecutionVariableBinaryWithHttpInfo

        public ApiResponse<Void> setLocalExecutionVariableBinaryWithHttpInfo​(String id,
                                                                     String varName,
                                                                     File data,
                                                                     String valueType)
                                                              throws ApiException
        Post Local Execution Variable (Binary) Sets the serialized value for a binary variable or the binary value for a file variable in the context of a given execution by id.
        Parameters:
        id - The id of the execution to set the variable for. (required)
        varName - The name of the variable to set. (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

      • setLocalExecutionVariableBinaryAsync

        public okhttp3.Call setLocalExecutionVariableBinaryAsync​(String id,
                                                         String varName,
                                                         File data,
                                                         String valueType,
                                                         ApiCallback<Void> _callback)
                                                  throws ApiException
        Post Local Execution Variable (Binary) (asynchronously) Sets the serialized value for a binary variable or the binary value for a file variable in the context of a given execution by id.
        Parameters:
        id - The id of the execution to set the variable for. (required)
        varName - The name of the variable to set. (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

      • signalExecutionCall

        public okhttp3.Call signalExecutionCall​(String id,
                                        ExecutionTriggerDto executionTriggerDto,
                                        ApiCallback _callback)
                                 throws ApiException
        Build call for signalExecution
        Parameters:
        id - The id of the execution to signal. (required)
        executionTriggerDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • signalExecution

        public void signalExecution​(String id,
                            ExecutionTriggerDto executionTriggerDto)
                     throws ApiException
        Trigger Execution Signals an execution by id. Can for example be used to explicitly skip user tasks or signal asynchronous continuations.
        Parameters:
        id - The id of the execution to signal. (required)
        executionTriggerDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • signalExecutionWithHttpInfo

        public ApiResponse<Void> signalExecutionWithHttpInfo​(String id,
                                                     ExecutionTriggerDto executionTriggerDto)
                                              throws ApiException
        Trigger Execution Signals an execution by id. Can for example be used to explicitly skip user tasks or signal asynchronous continuations.
        Parameters:
        id - The id of the execution to signal. (required)
        executionTriggerDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • signalExecutionAsync

        public okhttp3.Call signalExecutionAsync​(String id,
                                         ExecutionTriggerDto executionTriggerDto,
                                         ApiCallback<Void> _callback)
                                  throws ApiException
        Trigger Execution (asynchronously) Signals an execution by id. Can for example be used to explicitly skip user tasks or signal asynchronous continuations.
        Parameters:
        id - The id of the execution to signal. (required)
        executionTriggerDto - (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

      • triggerEventCall

        public okhttp3.Call triggerEventCall​(String id,
                                     String messageName,
                                     ExecutionTriggerDto executionTriggerDto,
                                     ApiCallback _callback)
                              throws ApiException
        Build call for triggerEvent
        Parameters:
        id - The id of the execution to submit the message to. (required)
        messageName - The name of the message that the addressed subscription corresponds to. (required)
        executionTriggerDto - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object

      • triggerEvent

        public void triggerEvent​(String id,
                         String messageName,
                         ExecutionTriggerDto executionTriggerDto)
                  throws ApiException
        Trigger Message Event Subscription Delivers a message to a specific execution by id, to trigger an existing message event subscription. Inject process variables as the message's payload.
        Parameters:
        id - The id of the execution to submit the message to. (required)
        messageName - The name of the message that the addressed subscription corresponds to. (required)
        executionTriggerDto - (optional)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • triggerEventWithHttpInfo

        public ApiResponse<Void> triggerEventWithHttpInfo​(String id,
                                                  String messageName,
                                                  ExecutionTriggerDto executionTriggerDto)
                                           throws ApiException
        Trigger Message Event Subscription Delivers a message to a specific execution by id, to trigger an existing message event subscription. Inject process variables as the message's payload.
        Parameters:
        id - The id of the execution to submit the message to. (required)
        messageName - The name of the message that the addressed subscription corresponds to. (required)
        executionTriggerDto - (optional)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

      • triggerEventAsync

        public okhttp3.Call triggerEventAsync​(String id,
                                      String messageName,
                                      ExecutionTriggerDto executionTriggerDto,
                                      ApiCallback<Void> _callback)
                               throws ApiException
        Trigger Message Event Subscription (asynchronously) Delivers a message to a specific execution by id, to trigger an existing message event subscription. Inject process variables as the message's payload.
        Parameters:
        id - The id of the execution to submit the message to. (required)
        messageName - The name of the message that the addressed subscription corresponds to. (required)
        executionTriggerDto - (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