WorkflowGroupProgressDto
DTO representing a workflow group with its associated step progress.
Used for organizing workflow steps into logical groups for display.
Uses sequential numbering instead of database IDs for security and simplicity.
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.). |
Sequential group number within the task (1, 2, 3, etc.). | ||
| groupName | string | The name of the workflow group. |
The name of the workflow group. | ||
| groupDescription | string | The description of the workflow group. |
The description of the workflow group. | ||
| groupDeadline | string | The calculated deadline for this workflow group. Example: If task is due March 15th and group has DeadlineIntervalValue = -3, DeadlineIntervalUnit = Day, This deadline applies to all steps within this group. |
The calculated deadline for this workflow group. Example: If task is due March 15th and group has DeadlineIntervalValue = -3, DeadlineIntervalUnit = Day, This deadline applies to all steps within this group. | ||
| steps | array of WorkflowStepProgressDto | The workflow steps belonging to this group. |
The workflow steps belonging to this group. | ||
| totalSteps | integer | The number of steps in this group. |
The number of steps in this group. | ||
| completedSteps | integer | The number of completed steps in this group. |
The number of completed steps in this group. | ||
| groupProgressPercentage | number | The percentage of completion for this group (0-100). |
The percentage of completion for this group (0-100). | ||
JSON Example
{
"groupNumber": 0,
"groupName": "string",
"groupDescription": "string",
"groupDeadline": "2024-01-01T00:00:00Z",
"steps": [
{
"stepNumber": "...",
"stepName": "...",
"stepDescription": "...",
"stepTimeEstimate": "...",
"status": "..."
}
]
}