WorkflowStepProgressDto

Represents the progress of a single workflow step within a TaskItem.
Contains both the step template information and the current execution status.

API Usage:

Part of TaskWorkflowProgressDto responses
Returned by individual step operations
Used for step-level progress tracking and assignment management

Properties

Name	Type	Description
stepNumber	integer	Sequential step number within the task (1, 2, 3, etc.). Used for referencing the step in API calls and ordering. Unique across all groups within this task.
Sequential step number within the task (1, 2, 3, etc.). Used for referencing the step in API calls and ordering. Unique across all groups within this task.
stepName	string	The name of the workflow step from the template. Describes what needs to be done in this step.
The name of the workflow step from the template. Describes what needs to be done in this step.
stepDescription	string	The detailed description of the workflow step from the template. Provides instructions or context for completing the step.
The detailed description of the workflow step from the template. Provides instructions or context for completing the step.
stepTimeEstimate	number	The estimated time to complete the workflow step in hours. Inherited from the WorkflowStep template for time planning and estimation.
The estimated time to complete the workflow step in hours. Inherited from the WorkflowStep template for time planning and estimation.
status	string	The current status of this workflow step instance. Uses TaskItemStatus enum values (NotStarted, InProgress, Blocked, Completed, Skipped).
The current status of this workflow step instance. Uses TaskItemStatus enum values (NotStarted, InProgress, Blocked, Completed, Skipped).
blockedReason	string	The reason this step is blocked. Only returned when the status is "Blocked".
The reason this step is blocked. Only returned when the status is "Blocked".
assignedUser	CodeAndNameDto
completedByUser	CodeAndNameDto
completedDate	string	The date and time when this step was completed. Null if the step is not yet completed. Used for tracking completion timeline and performance metrics.
The date and time when this step was completed. Null if the step is not yet completed. Used for tracking completion timeline and performance metrics.
canStart	boolean	Whether this step can be started based on its dependencies. True if all prerequisite steps are completed, false otherwise. Used by the UI to enable/disable step actions.
Whether this step can be started based on its dependencies. True if all prerequisite steps are completed, false otherwise. Used by the UI to enable/disable step actions.
stepType	enum	Standard SendEmail
Standard SendEmail
emailStepConfiguration	EmailStepConfigDto
emailExecutionState	EmailExecutionStateDto
notes	array of NoteDto	Notes attached to this workflow step. Uses the TaskItemNote system for rich note support including pinning.
Notes attached to this workflow step. Uses the TaskItemNote system for rich note support including pinning.
dependsOnSteps	array of integer	Sequential step numbers that this step depends on within this task. These are the StepNumber values (e.g., [2, 5, 7]). These steps must be completed before this step can be started.
Sequential step numbers that this step depends on within this task. These are the StepNumber values (e.g., [2, 5, 7]). These steps must be completed before this step can be started.

JSON Example

{
  "stepNumber": 0,
  "stepName": "string",
  "stepDescription": "string",
  "stepTimeEstimate": 0,
  "status": "string"
}

Used By Operations

Contained in Schemas

WorkflowGroupProgressDto Represents a workflow group with its associated step progress. Used for organizing workflow steps in...