Version: 8.10 (unreleased)

Type Alias: AgentDefinitionResult

type AgentDefinitionResult = object;

An agent definition, created at deploy time for the process element it belongs to.

Properties

agentDefinitionKey: AgentDefinitionKey;

The unique key for this agent definition. Unique across process definition versions.

agentType: AgentDefinitionTypeEnum;

elementId: ElementId;

The BPMN element ID of the process element that owns the agent definition.

name: string;

The human-readable name of the process element that owns the agent definition. Falls back to elementId when the element has no BPMN name configured.

processDefinitionId: ProcessDefinitionId;

The BPMN process ID of the process definition that owns the agent definition.

processDefinitionKey: ProcessDefinitionKey;

The key of the process definition that owns the agent definition.

processDefinitionVersion: number;

The version of the process definition that owns the agent definition.

processDefinitionVersionTag: string | null;

The version tag of the process definition that owns the agent definition.

tenantId: TenantId;

The tenant ID of this agent definition.