Decision Definition¶

This module provides access to the decision definition REST api of Camunda.

DecisionDefinition¶

class pycamunda.decisiondef.DecisionDefinition(id_: str, key: str, category: str, name: str, version: int, resource: str, deployment_id: str, decision_requirements_definition_id: str, decision_requirements_definition_key: str, tenant_id: str, version_tag: str, history_time_to_live: int)¶: Data class of decision definition as returned by the REST api of Camunda.

GetList¶

class pycamunda.decisiondef.GetList(url: str, id_: Optional[str] = None, id_in: Optional[Iterable[str]] = None, name: Optional[str] = None, name_like: Optional[str] = None, deployment_id: Optional[str] = None, key: Optional[str] = None, key_like: Optional[str] = None, category: Optional[str] = None, category_like: Optional[str] = None, version: Optional[str] = None, latest_version: bool = False, resource_name: Optional[str] = None, resource_name_like: Optional[str] = None, tenant_id_in: Optional[Iterable[str]] = None, without_tenant_id: bool = False, include_without_tenant_id: bool = False, sort_by: Optional[str] = None, ascending: bool = True, first_result: Optional[int] = None, max_results: Optional[int] = None)¶

Query for a list of decision definitions using a list of parameters. The size of the result set can be retrieved by using the Count method.

Parameters:

url – Camunda Rest engine URL.
id – Filter by id.
id_in – Filter whether the id is one of multiple ones.
name – Filter by name.
name_like – Filter by a substring of the name.
deployment_id – Filter by deployment id.
key – Key of the process definition.
key_like – Filter by a substring of the key.
category – Filter by category.
category_like – Filter by a substring of the category.
version – Filter by version.
latest_version – Whether to include only the latest versions.
resource_name – Filter by resource name.
resource_name_like – Filter by a substring of the resource name.
tenant_id_in – Filter whether the tenant id is one of multiple ones.
without_tenant_id – Whether to include only decision definitions that belong to no tenant.
include_without_tenant_id – Whether to include decision definitions that belong to no tenant.
sort_by – Sort the results by ‘category’, ‘key’, ‘id_’, ‘name’, ‘version’, ‘deployment_id’ or ‘tenant_id’. Sorting by ‘version_tag’ is string-based.
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.

__call__(*args, **kwargs) → Tuple[pycamunda.decisiondef.DecisionDefinition]¶: Send the request.

Count¶

class pycamunda.decisiondef.Count(url: str, id_: Optional[str] = None, id_in: Optional[Iterable[str]] = None, name: Optional[str] = None, name_like: Optional[str] = None, deployment_id: Optional[str] = None, key: Optional[str] = None, key_like: Optional[str] = None, category: Optional[str] = None, category_like: Optional[str] = None, version: Optional[str] = None, latest_version: bool = False, resource_name: Optional[str] = None, resource_name_like: Optional[str] = None, tenant_id_in: Optional[Iterable[str]] = None, without_tenant_id: bool = False, include_without_tenant_id: bool = False)¶

Count decision definitions.

Parameters:

url – Camunda Rest engine URL.
id – Filter by id.
id_in – Filter whether the id is one of multiple ones.
name – Filter by name.
name_like – Filter by a substring of the name.
deployment_id – Filter by deployment id.
key – Key of the process definition.
key_like – Filter by a substring of the key.
category – Filter by category.
category_like – Filter by a substring of the category.
version – Filter by version.
latest_version – Whether to include only the latest versions.
resource_name – Filter by resource name.
resource_name_like – Filter by a substring of the resource name.
tenant_id_in – Filter whether the tenant id is one of multiple ones.
without_tenant_id – Whether to include only decision definitions that belong to no tenant.
include_without_tenant_id – Whether to include decision definitions that belong to no tenant.

__call__(*args, **kwargs) → Tuple[pycamunda.decisiondef.DecisionDefinition]¶: Send the request.

Get¶

class pycamunda.decisiondef.Get(url: str, id_: Optional[str] = None, key: Optional[str] = None, tenant_id: Optional[str] = None)¶

Get a decision definition.

Parameters:	url – Camunda Rest engine URL. id – Id of the decision definition. key – Key of the decision definition. tenant_id – Id of the tenant the decision definition belongs to.

__call__(*args, **kwargs) → pycamunda.decisiondef.DecisionDefinition¶: Send the request.

GetXML¶

class pycamunda.decisiondef.GetXML(url: str, id_: Optional[str] = None, key: Optional[str] = None, tenant_id: Optional[str] = None)¶

Retrieve the CMMN XML of a decision definition.

Parameters:	url – Camunda Rest engine URL. id – Id of the decision definition. key – Key of the decision definition. tenant_id – Id of the tenant the decision definition belongs to.

__call__(*args, **kwargs) → str¶: Send the request.

GetDiagram¶

class pycamunda.decisiondef.GetDiagram(url: str, id_: Optional[str] = None, key: Optional[str] = None, tenant_id: Optional[str] = None)¶

Get the diagram of a decision definition.

Parameters:	url – Camunda Rest engine URL. id – Id of the decision definition. key – Key of the decision definition.

__call__(*args, **kwargs)¶: Send the request.

Evaluate¶

class pycamunda.decisiondef.Evaluate(url: str, id_: Optional[str] = None, key: Optional[str] = None, tenant_id: Optional[str] = None)¶

Evaluate the result of a decision definition.

Parameters:	url – Camunda Rest engine URL. id – Id of the decision definition. key – Key of the decision definition. tenant_id – Id of the tenant the decision definition belongs to.

__call__(*args, **kwargs) → Tuple[Dict[KT, VT]]¶: Send the request.

add_variable(name: str, value: Any, type_: Optional[str] = None, value_info: Optional[str] = None) → None¶

Add a variable for the evaluation of the decision definition.

Parameters:	name – Name of the variable. value – Value of the variable. type – Value type of the variable. value_info – Additional information regarding the value type.