API Docs / Schemas / WorkflowStepDto

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
namestring
descriptionstring
timeEstimatenumber
stepNumberinteger

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.

stepTypeenum

Standard SendEmail

Standard SendEmail

assignmentTypeenum

TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate

TaskOwner SpecificUser ClientManager ClientServiceManager ClientPartner ClientAssociate

assignedUserCodeAndNameDto
billableServiceCodeAndNameDto
dependsOnStepNumbersarray 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.

emailStepConfigurationEmailStepConfigDto

JSON Example

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

Contained in Schemas