WorkflowInstanceData
Description
Represents a workflow instance within a process instance.
The WorkflowInstanceData model provides execution details, lifecycle information, and hierarchical relationships of workflows associated with a process instance.
Constructor
| Constructor | Description |
|---|---|
WorkflowInstanceData() | Initializes a new instance of the WorkflowInstanceData model. |
Properties
| Property | Description |
|---|---|
Id | The unique identifier of the workflow instance. |
TenantId | The tenant ID associated with the workflow instance. |
ProcessInstanceId | The ID of the process instance to which the workflow belongs. |
DefinitionId | The workflow definition ID. |
DefinitionVersionId | The workflow definition version ID. |
ParentWorkflowInstanceId | The parent workflow instance ID, if applicable. |
ParentActivityInstanceId | The parent activity instance ID, if applicable. |
ParentActivityId | The parent activity definition ID, if applicable. |
WorkflowState | The current execution state of the workflow. |
Status | The workflow status code. |
SubStatus | The workflow sub-status code. |
IsExecuting | Indicates whether the workflow is currently executing. |
CorrelationId | The correlation identifier used for tracking and tracing. |
Name | The display name of the workflow instance. |
IncidentCount | The number of incidents associated with the workflow instance. |
IsSystem | Indicates whether the workflow instance is a system workflow. |
CreatedAt | The date and time when the workflow instance was created. |
UpdatedAt | The date and time when the workflow instance was last updated. |
FinishedAt | The date and time when the workflow instance completed execution, if applicable. |
Remarks
- This model is typically returned by Process Instance APIs.
- It provides visibility into workflow execution state and lifecycle progression.
- Parent-related properties are populated when the workflow is triggered from another workflow or activity.
FinishedAtis populated only after workflow completion.