Variable

This module provides access to the variable instance REST api of Camunda

Variable

class pycamunda.variable.Variable(value: Any, type_: str, value_info: Dict[KT, VT], local: Optional[bool] = None)

Data class of variable as returned by the REST api of Camunda.

local = None

VariableInstance

class pycamunda.variable.VariableInstance(id_: str, name: str, type_: str, value: Any, value_info: Dict[KT, VT], process_instance_id: str, execution_id: str, case_instance_id: str, case_execution_id: str, task_id: str, activity_instance_id: str, tenant_id: str, error_message: str)

Data class of variable instance as returned by the REST api of Camunda.

GetList

class pycamunda.variable.GetList(url: str, name: Optional[str] = None, name_like: Optional[str] = None, process_instance_id_in: Optional[Iterable[str]] = None, case_instance_id_in: Optional[Iterable[str]] = None, case_execution_id_in: Optional[Iterable[str]] = None, task_id_in: Optional[Iterable[str]] = None, activity_instance_id_in: Optional[Iterable[str]] = None, tenant_id_in: Optional[Iterable[str]] = None, sort_by: Optional[str] = None, ascending: bool = True, first_result: Optional[int] = None, max_results: Optional[int] = None, deserialize_values: bool = False)

Get a list of variable instances.

Parameters:
  • url – Camunda Rest engine URL.
  • name – Filter by variable name.
  • name_like – Filter by a substring of the variable name.
  • process_instance_id_in – Filter whether the process instance id is one of multiple ones.
  • case_instance_id_in – Filter whether the case instance id is one of multiple ones.
  • case_execution_id_in – Filter whether the case execution id is one of multiple ones.
  • task_id_in – Filter whether the task id is one of multiple ones.
  • activity_instance_id_in – Filter whether the activity instance id is one of multiple ones.
  • tenant_id_in – Filter whether the tenant id is one of multiple ones.
  • sort_by – Sort the results by ‘name’, ‘type_’, ‘activity_instance_id’ or ‘tenant_id’.
  • ascending – Sort order.
  • first_result – Pagination of results. Index of the first result to return.
  • max_results – Pagination of results. Maximum number of results to return.
  • deserialize_values – Whether serializable variable values are deserialized on server side.
__call__(*args, **kwargs) → Tuple[pycamunda.variable.VariableInstance]

Send the request.

add_equal_value_filter(name: str, value: Any) → None

Add a filter to include only variables with values equal a provided value.

Parameters:
  • name – Name of the variable.
  • value – Value to filter for.
add_greater_than_equal_value_filter(name: str, value: Any) → None

Add a filter to include only variables with values greater than or equal a provided value.

Parameters:
  • name – Name of the variable.
  • value – Value to filter for.
add_greater_than_value_filter(name: str, value: Any) → None

Add a filter to include only variables with values greater than a provided value.

Parameters:
  • name – Name of the variable.
  • value – Value to filter for.
add_less_than_equal_value_filter(name: str, value: Any) → None

Add a filter to include only variables with values less than or equal a provided value.

Parameters:
  • name – Name of the variable.
  • value – Value to filter for.
add_less_than_value_filter(name: str, value: Any) → None

Add a filter to include only variables with values less than a provided value.

Parameters:
  • name – Name of the variable.
  • value – Value to filter for.
add_like_value_filter(name: str, value: Any) → None

Add a filter to include only variables with values like a provided value.

Parameters:
  • name – Name of the variable.
  • value – Value to filter for.
add_not_equal_value_filter(name: str, value: Any) → None

Add a filter to include only variables with values not equal a provided value.

Parameters:
  • name – Name of the variable.
  • value – Value to filter for.

Get

class pycamunda.variable.Get(url: str, id_: str, deserialize_value: bool = False)

Get a variable instance.

Parameters:
  • url – Camunda Rest engine URL.
  • id – Id of the variable instance.
  • deserialize_value – Whether serializable variable values are deserialized on server side.
__call__(*args, **kwargs) → pycamunda.variable.VariableInstance

Send the request.