Skip to main content
Version: 8.10 (unreleased)

Type Alias: AgentInstanceFilter

type AgentInstanceFilter = object;

Agent instance search filter.

Properties​

agentInstanceKey?​

optional agentInstanceKey?: AgentInstanceKeyFilterProperty;

The unique key of the agent instance.

completionDate?​

optional completionDate?: DateTimeFilterProperty;

The completion date of the agent instance.

creationDate?​

optional creationDate?: DateTimeFilterProperty;

The creation date of the agent instance.

elementId?​

optional elementId?: ElementIdFilterProperty;

The BPMN element ID of the agent task.

elementInstanceKeys?​

optional elementInstanceKeys?: ElementInstanceKeyFilterProperty[];

The keys of element instances associated with this agent instance. If multiple keys are provided, the filter matches agent instances associated with all of the provided keys at the same time.

lastUpdatedDate?​

optional lastUpdatedDate?: DateTimeFilterProperty;

The date the agent instance was last updated.

processDefinitionKey?​

optional processDefinitionKey?: ProcessDefinitionKeyFilterProperty;

The key of the process definition associated with this agent instance.

processInstanceKey?​

optional processInstanceKey?: ProcessInstanceKeyFilterProperty;

The key of the process instance that owns this agent instance.

status?​

optional status?: AgentInstanceStatusFilterProperty;

The current status of the agent instance.

tenantId?​

optional tenantId?: StringFilterProperty;

The tenant ID of the agent instance.