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

Class ExecutionApi

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

  • Constructor Details

    • ExecutionApi

      public ExecutionApi()

    • ExecutionApi

      public ExecutionApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

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

    • createIncident

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

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

    • deleteLocalExecutionVariable

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

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

    • getExecution

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

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

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

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

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

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

    • getLocalExecutionVariable

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

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

    • getLocalExecutionVariableBinary

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

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

    • getLocalExecutionVariables

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

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

    • getMessageEventSubscription

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

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

    • modifyLocalExecutionVariables

      public void modifyLocalExecutionVariables(String id, PatchVariablesDto patchVariablesDto, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

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

    • putLocalExecutionVariable

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

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

    • queryExecutions

      public List<ExecutionDto> queryExecutions(Integer firstResult, Integer maxResults, ExecutionQueryDto executionQueryDto, Map<String,String> additionalHeaders) 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.21/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)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<ExecutionDto>
      Throws:
      ApiException - if fails to make API call

    • 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.21/reference/rest/execution/post-query/) method and therefore it is slightly more powerful than the [Get Execution Count](https://docs.camunda.org/manual/7.21/reference/rest/execution/get-query-count/) method.
      Parameters:
      executionQueryDto - (optional)
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

    • queryExecutionsCount

      public CountResultDto queryExecutionsCount(ExecutionQueryDto executionQueryDto, Map<String,String> additionalHeaders) 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.21/reference/rest/execution/post-query/) method and therefore it is slightly more powerful than the [Get Execution Count](https://docs.camunda.org/manual/7.21/reference/rest/execution/get-query-count/) method.
      Parameters:
      executionQueryDto - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      CountResultDto
      Throws:
      ApiException - if fails to make API call

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

    • setLocalExecutionVariableBinary

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

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

    • signalExecution

      public void signalExecution(String id, ExecutionTriggerDto executionTriggerDto, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

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

    • triggerEvent

      public void triggerEvent(String id, String messageName, ExecutionTriggerDto executionTriggerDto, Map<String,String> additionalHeaders) 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)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call