Skip to main content
Version: 8.9 (unreleased)

Type Alias: GetElementInstanceResponses

type GetElementInstanceResponses = object;

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

Properties​

200​

200: object;

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

The element instance is successfully returned.

elementId​

elementId: ElementId;

The element ID for this element instance.

elementInstanceKey​

elementInstanceKey: ElementInstanceKey;

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

elementName​

elementName: string;

The element name for this element instance.

endDate?​

optional endDate: string;

Date when element instance finished.

hasIncident​

hasIncident: boolean;

Shows whether this element instance has an incident. If true also an incidentKey is provided.

incidentKey?​

optional incidentKey: IncidentKey;

Incident key associated with this element instance.

processDefinitionId​

processDefinitionId: ProcessDefinitionId;

The process definition ID associated to this element instance.

processDefinitionKey​

processDefinitionKey: ProcessDefinitionKey;

The process definition key associated to this element instance.

processInstanceKey​

processInstanceKey: ProcessInstanceKey;

The process instance key associated to this element instance.

rootProcessInstanceKey?​

optional rootProcessInstanceKey: ProcessInstanceKey;

startDate​

startDate: string;

Date when element instance started.

state​

state: ElementInstanceStateEnum;

State of element instance as defined set of values.

tenantId​

tenantId: TenantId;

The tenant ID of the incident.

type​

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";

Type of element as defined set of values.