WorkflowGroupDto

DTO for workflow groups within a workflow.

Workflow Group Deadlines:
Groups define deadlines relative to the TaskItem's due date using DeadlineIntervalValue and DeadlineIntervalUnit.
When a workflow is assigned to a task, each group's deadline is calculated as:
Group Deadline = TaskItem.DueDate + (DeadlineIntervalValue * DeadlineIntervalUnit)

All workflow steps within a group inherit the group's calculated deadline.

Properties

Name	Type	Description
name	string	The name of the workflow group
The name of the workflow group
description	string	The description of the workflow group
The description of the workflow group
deadlineIntervalValue	integer	The deadline interval value relative to the TaskItem's due date. API Usage Examples: Positive values: Days/weeks/months AFTER the task due date DeadlineIntervalValue = 1, DeadlineIntervalUnit = "Week" → 1 week after task deadline DeadlineIntervalValue = 5, DeadlineIntervalUnit = "Day" → 5 days after task deadline Negative values: Days/weeks/months BEFORE the task due date DeadlineIntervalValue = -2, DeadlineIntervalUnit = "Day" → 2 days before task deadline DeadlineIntervalValue = -1, DeadlineIntervalUnit = "Week" → 1 week before task deadline Zero: Same as the task due date DeadlineIntervalValue = 0, DeadlineIntervalUnit = "Day" → Same day as task deadline When creating or updating workflows, this allows you to structure work phases: Example: Tax Return Workflow "Data Collection" group: -14 days (2 weeks before tax deadline) "Preparation" group: -7 days (1 week before tax deadline) "Review" group: -1 day (1 day before tax deadline) "Filing" group: 0 days (same as tax deadline)
The deadline interval value relative to the TaskItem's due date. API Usage Examples: Positive values: Days/weeks/months AFTER the task due date DeadlineIntervalValue = 1, DeadlineIntervalUnit = "Week" → 1 week after task deadline DeadlineIntervalValue = 5, DeadlineIntervalUnit = "Day" → 5 days after task deadline Negative values: Days/weeks/months BEFORE the task due date DeadlineIntervalValue = -2, DeadlineIntervalUnit = "Day" → 2 days before task deadline DeadlineIntervalValue = -1, DeadlineIntervalUnit = "Week" → 1 week before task deadline Zero: Same as the task due date DeadlineIntervalValue = 0, DeadlineIntervalUnit = "Day" → Same day as task deadline When creating or updating workflows, this allows you to structure work phases: Example: Tax Return Workflow "Data Collection" group: -14 days (2 weeks before tax deadline) "Preparation" group: -7 days (1 week before tax deadline) "Review" group: -1 day (1 day before tax deadline) "Filing" group: 0 days (same as tax deadline)
deadlineIntervalUnit	enum	Day Week Month Year
Day Week Month Year
groupNumber	integer	The group number that determines the display order and sequencing of this group within the workflow. Groups are displayed in ascending order by this number (1, 2, 3, etc.).
The group number that determines the display order and sequencing of this group within the workflow. Groups are displayed in ascending order by this number (1, 2, 3, etc.).
steps	array of WorkflowStepDto	The workflow steps contained within this group. All steps inherit the group's calculated deadline for planning and prioritization.
The workflow steps contained within this group. All steps inherit the group's calculated deadline for planning and prioritization.

JSON Example

{
  "name": "string",
  "description": "string",
  "deadlineIntervalValue": 0,
  "deadlineIntervalUnit": "Day",
  "groupNumber": 0
}

WorkflowGroupDto

Properties

JSON Example

Contained in Schemas