WorkflowStepDto

DTO for workflow steps within a workflow group.
Used for both create/update requests and GET responses for workflow templates.

Properties

Name	Type	Description
name	string
description	string
timeEstimateMinutes	integer
stepNumber	integer	The step number within the workflow group. Used for ordering steps and referencing dependencies. If 0-based numbering is provided, it will be automatically converted to 1-based.
The step number within the workflow group. Used for ordering steps and referencing dependencies. If 0-based numbering is provided, it will be automatically converted to 1-based.
stepType	enum	Standard SendEmail DocumentRequest DocumentApproval ClientConfirmation SendDataForm SetServiceStage UpdateClientData SetPipelineStage
Standard SendEmail DocumentRequest DocumentApproval ClientConfirmation SendDataForm SetServiceStage UpdateClientData SetPipelineStage
autoExecute	boolean	Whether this step executes automatically when its dependencies are met. False means the user must manually trigger execution. Only relevant for executable step types (SendEmail, DocumentRequest, ClientConfirmation).
Whether this step executes automatically when its dependencies are met. False means the user must manually trigger execution. Only relevant for executable step types (SendEmail, DocumentRequest, ClientConfirmation).
assignmentType	enum	TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate DoNotAssign
assignedUser	CodeAndNameDto
assignedTeam	CodeAndNameDto
billableService	CodeAndNameDto
dependsOnStepNumbers	array of integer	The step numbers that this step depends on (must be completed first). Can use either 0-based [0, 1] or 1-based [1, 2] numbering - 0-based will be auto-converted. Example: [1, 2] means this step depends on steps 1 and 2 being completed first.
The step numbers that this step depends on (must be completed first). Can use either 0-based [0, 1] or 1-based [1, 2] numbering - 0-based will be auto-converted. Example: [1, 2] means this step depends on steps 1 and 2 being completed first.
emailStepConfiguration	EmailStepConfigDto
documentRequestStepConfiguration	DocumentRequestStepConfigDto
documentApprovalStepConfiguration	DocumentApprovalStepConfigDto
clientConfirmationStepConfiguration	ClientConfirmationStepConfigDto
sendDataFormStepConfiguration	SendDataFormStepConfigDto
setServiceStageStepConfiguration	SetServiceStageStepConfigDto
setPipelineStageStepConfiguration	SetPipelineStageStepConfigDto
updateClientDataStepConfiguration	UpdateClientDataStepConfigDto
checklist	array of ChecklistItemDto	Checklist items for this workflow step template
Checklist items for this workflow step template
condition	ConditionDto
clientTypes	array of enum	The types of clients this step is applicable to. An empty list means the step applies to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association
The types of clients this step is applicable to. An empty list means the step applies to all client types. PrivateLimitedCompany PublicLimitedCompany LimitedLiabilityPartnership Partnership Individual Trust Charity SoleTrader Association

JSON Example

{
  "name": "string",
  "description": "string",
  "timeEstimateMinutes": 0,
  "stepNumber": 0,
  "stepType": "Standard"
}

Contained in Schemas

WorkflowGroupDto DTO for workflow groups within a workflow. Workflow Group Deadlines: Groups define dead...