WorkflowGroupProgressDto

Represents a workflow group with its associated step progress.
Used for organizing workflow steps into logical groups for display.

API Usage:

Part of TaskWorkflowProgressDto for grouped step display
Helps organize large workflows into manageable sections
Provides group-level progress statistics and deadline information

Properties

Name	Type	Description
groupNumber	integer	Sequential group number within the task (1, 2, 3, etc.). Used for referencing the group in API calls and ordering display.
Sequential group number within the task (1, 2, 3, etc.). Used for referencing the group in API calls and ordering display.
groupName	string	The name of the workflow group. Used for section headers and group organization.
The name of the workflow group. Used for section headers and group organization.
groupDescription	string	The description of the workflow group. Provides context for the group's purpose.
The description of the workflow group. Provides context for the group's purpose.
dependsOnPreviousGroup	boolean	Whether every step in this group waits for all steps in the previous group to be completed or skipped before it can start.
Whether every step in this group waits for all steps in the previous group to be completed or skipped before it can start.
groupDeadline	string	The calculated deadline for this workflow group. This is computed as TaskItem.DueDate + (DeadlineIntervalValue * DeadlineIntervalUnit) when the workflow is assigned to a task. Example: If task is due March 15th and group has DeadlineIntervalValue = -3, DeadlineIntervalUnit = Day, then GroupDeadline would be March 12th (3 days before task deadline). This deadline applies to all steps within this group.
The calculated deadline for this workflow group. This is computed as TaskItem.DueDate + (DeadlineIntervalValue * DeadlineIntervalUnit) when the workflow is assigned to a task. Example: If task is due March 15th and group has DeadlineIntervalValue = -3, DeadlineIntervalUnit = Day, then GroupDeadline would be March 12th (3 days before task deadline). This deadline applies to all steps within this group.
steps	array of WorkflowStepProgressDto	The workflow steps belonging to this group. Ordered by step number for consistent display.
The workflow steps belonging to this group. Ordered by step number for consistent display.
totalSteps	integer	The number of steps in this group. Used for group-level progress calculations.
The number of steps in this group. Used for group-level progress calculations.
completedSteps	integer	The number of completed steps in this group. Used for group-level progress visualization.
The number of completed steps in this group. Used for group-level progress visualization.
groupProgressPercentage	number	The percentage of completion for this group (0-100). Calculated as (CompletedSteps / TotalSteps) * 100. Used for group-level progress bars.
The percentage of completion for this group (0-100). Calculated as (CompletedSteps / TotalSteps) * 100. Used for group-level progress bars.
isOmitted	boolean	Whether this group is omitted because its visibility condition is not met by the task's primary client (set only when every step in the group is omitted).
Whether this group is omitted because its visibility condition is not met by the task's primary client (set only when every step in the group is omitted).
omittedReason	string	Human-readable explanation of why this group is omitted. Null when not omitted.
Human-readable explanation of why this group is omitted. Null when not omitted.

JSON Example

{
  "groupNumber": 0,
  "groupName": "string",
  "groupDescription": "string",
  "dependsOnPreviousGroup": false,
  "groupDeadline": "2024-01-01T00:00:00Z"
}