API Docs / Schemas / WorkflowGroupProgressDto

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
groupNumberinteger

Sequential group number within the task (1, 2, 3, etc.).
Used for referencing the group and ordering display.
Replaces database WorkflowGroupId for security.

Sequential group number within the task (1, 2, 3, etc.).
Used for referencing the group and ordering display.
Replaces database WorkflowGroupId for security.

groupNamestring

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.

groupDescriptionstring

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.

groupDeadlinestring

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.

stepsarray 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.

totalStepsinteger

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.

completedStepsinteger

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.

groupProgressPercentagenumber

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.

JSON Example

{
  "groupNumber": 0,
  "groupName": "string",
  "groupDescription": "string",
  "groupDeadline": "2024-01-01T00:00:00Z",
  "steps": [
    {
      "stepNumber": "...",
      "stepName": "...",
      "stepDescription": "...",
      "stepTimeEstimate": "...",
      "status": "..."
    }
  ]
}