Skip to main content
Version: 8.9 (unreleased)

Type Alias: ElementInstanceFilter

type ElementInstanceFilter = object;

Defined in: gen/types.gen.ts:2403

Element instance filter.

Properties​

elementId?​

optional elementId: ElementId;

Defined in: gen/types.gen.ts:2419

The element ID for this element instance.

elementInstanceKey?​

optional elementInstanceKey: ElementInstanceKey;

Defined in: gen/types.gen.ts:2433

The assigned key, which acts as a unique identifier for this element instance.

elementInstanceScopeKey?​

optional elementInstanceScopeKey:
  | ElementInstanceKey
  | ProcessInstanceKey;

Defined in: gen/types.gen.ts:2458

The scope key of this element instance. If provided with a process instance key it will return element instances that are immediate children of the process instance. If provided with an element instance key it will return element instances that are immediate children of the element instance.

elementName?​

optional elementName: string;

Defined in: gen/types.gen.ts:2424

The element name. This only works for data created with 8.8 and onwards. Instances from prior versions don't contain this data and cannot be found.

endDate?​

optional endDate: DateTimeFilterProperty;

Defined in: gen/types.gen.ts:2453

The end date of this element instance.

hasIncident?​

optional hasIncident: boolean;

Defined in: gen/types.gen.ts:2428

Shows whether this element instance has an incident related to.

incidentKey?​

optional incidentKey: IncidentKey;

Defined in: gen/types.gen.ts:2445

The key of incident if field incident is true.

processDefinitionId?​

optional processDefinitionId: ProcessDefinitionId;

Defined in: gen/types.gen.ts:2407

The process definition ID associated to this element instance.

processDefinitionKey?​

optional processDefinitionKey: ProcessDefinitionKey;

Defined in: gen/types.gen.ts:2441

The process definition key associated to this element instance.

processInstanceKey?​

optional processInstanceKey: ProcessInstanceKey;

Defined in: gen/types.gen.ts:2437

The process instance key associated to this element instance.

startDate?​

optional startDate: DateTimeFilterProperty;

Defined in: gen/types.gen.ts:2449

The start date of this element instance.

state?​

optional state: ElementInstanceStateFilterProperty;

Defined in: gen/types.gen.ts:2411

State of element instance as defined set of values.

tenantId?​

optional tenantId: TenantId;

Defined in: gen/types.gen.ts:2429

type?​

optional type:
  | "UNSPECIFIED"
  | "PROCESS"
  | "SUB_PROCESS"
  | "EVENT_SUB_PROCESS"
  | "AD_HOC_SUB_PROCESS"
  | "AD_HOC_SUB_PROCESS_INNER_INSTANCE"
  | "START_EVENT"
  | "INTERMEDIATE_CATCH_EVENT"
  | "INTERMEDIATE_THROW_EVENT"
  | "BOUNDARY_EVENT"
  | "END_EVENT"
  | "SERVICE_TASK"
  | "RECEIVE_TASK"
  | "USER_TASK"
  | "MANUAL_TASK"
  | "TASK"
  | "EXCLUSIVE_GATEWAY"
  | "INCLUSIVE_GATEWAY"
  | "PARALLEL_GATEWAY"
  | "EVENT_BASED_GATEWAY"
  | "SEQUENCE_FLOW"
  | "MULTI_INSTANCE_BODY"
  | "CALL_ACTIVITY"
  | "BUSINESS_RULE_TASK"
  | "SCRIPT_TASK"
  | "SEND_TASK"
  | "UNKNOWN";

Defined in: gen/types.gen.ts:2415

Type of element as defined set of values.