API Docs / Schemas / PendingWorkflowStepDto

PendingWorkflowStepDto

Lightweight projection of a manual-mode outbound workflow step that is ready to send.
These are steps where dependencies are met and a user needs to review and trigger the send.

Properties

Name Type Description
idinteger

The workflow step ID

The workflow step ID

stepNamestring

The name of the workflow step

The name of the workflow step

stepTypeenum

Standard SendEmail DocumentRequest DocumentApproval ClientConfirmation SendDataForm SetServiceStage UpdateClientData SetPipelineStage

Standard SendEmail DocumentRequest DocumentApproval ClientConfirmation SendDataForm SetServiceStage UpdateClientData SetPipelineStage

statusenum

NotStarted InProgress Blocked Completed Skipped

NotStarted InProgress Blocked Completed Skipped

taskCodeAndNameDto
clientCodeAndNameDto
taskCategoryCodeAndNameDto
assignedUserCodeAndNameDto
assignedTeamCodeAndNameDto
groupNamestring

The workflow group name

The workflow group name

groupNumberinteger

The group number within the workflow

The group number within the workflow

stepNumberinteger

The step number within the group

The step number within the group

deadlinestring

The group's calculated deadline (from the task's due date + group interval)

The group's calculated deadline (from the task's due date + group interval)

createdDatestring

When the step was created

When the step was created

JSON Example

{
  "id": 0,
  "stepName": "string",
  "stepType": "Standard",
  "status": "NotStarted",
  "task": {
    "code": "string",
    "name": "string"
  }
}

Contained in Schemas