Signal

This module provides access to the signal REST api of Camunda.

EventAll

class pycamunda.signal.EventAll(url: str, name: str, tenant_id: Optional[str] = None, without_tenant_id: bool = False)

Deliver a signal to all process definitions and executions with the specific signal handler.

Parameters:
  • url – Camunda Rest engine URL.
  • name – Name of the signal.
  • tenant_id – Id of the tenant. Signal will only be delivered to process definitions or executions that belong to this tenant.
  • without_tenant_id – Whether to deliver the signal only to process definitions or executions without tenant.
__call__(*args, **kwargs) → None

Send the request.

add_variable(name: str, value: Any, type_: Optional[str] = None, value_info: Optional[Mapping[KT, VT_co]] = None)

Add variables to the process after correlating the message.

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.

EventSingle

class pycamunda.signal.EventSingle(url: str, name: str, execution_id: str)

Deliver a signal to all process definitions and executions with the specific signal handler.

Parameters:
  • url – Camunda Rest engine URL.
  • name – Name of the signal.
  • execution_id – Id of the execution to deliver the signal to.
__call__(*args, **kwargs) → None

Send the request.

add_variable(name: str, value: Any, type_: Optional[str] = None, value_info: Optional[Mapping[KT, VT_co]] = None)

Add variables to the process after correlating the message.

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.