Properties
| Name | Type | Description |
|---|---|---|
| step | CodeAndNameDto | |
| workflowGroup | CodeAndNameDto | |
| groupDeadline | string | The deadline for the workflow group containing this step |
The deadline for the workflow group containing this step | ||
| plannedDate | string | The date this step is planned for. Null means the step sits on the task's start date. |
The date this step is planned for. Null means the step sits on the task's start date. | ||
| plannedTime | string | Time of day on SodiumHQ.DTOs.WorkItems.WorkflowStepDetailsDto.PlannedDate. Null means the task's start time. |
Time of day on SodiumHQ.DTOs.WorkItems.WorkflowStepDetailsDto.PlannedDate. Null means the task's start time. | ||
| status | enum | NotStarted InProgress Blocked Completed Skipped |
NotStarted InProgress Blocked Completed Skipped | ||
| isOverdue | boolean | Indicates if the workflow step is overdue (GroupDeadline is before today and status is not Completed or Skipped) |
Indicates if the workflow step is overdue (GroupDeadline is before today and status is not Completed or Skipped) | ||
| blockedReason | string | The reason this step is blocked. Only populated when Status is Blocked. |
The reason this step is blocked. Only populated when Status is Blocked. | ||
| completedDate | string | When this workflow step was completed (if applicable) |
When this workflow step was completed (if applicable) | ||
| assignedTo | CodeAndNameDto | |
| assignedTeam | CodeAndNameDto | |
| canStart | boolean | Indicates whether this step can be started based on its dependency requirements |
Indicates whether this step can be started based on its dependency requirements | ||
| checklist | array of ChecklistItemDto | Checklist items for this workflow step |
Checklist items for this workflow step | ||
| scheduledSendCode | string | Code of the send waiting to go out for this step, if one is scheduled |
Code of the send waiting to go out for this step, if one is scheduled | ||
| scheduledSendAt | string | When the scheduled send is due to go out (UTC), if one is scheduled |
When the scheduled send is due to go out (UTC), if one is scheduled | ||
JSON Example
{
"step": {
"code": "string",
"name": "string"
},
"workflowGroup": {
"code": "string",
"name": "string"
},
"groupDeadline": "2024-01-01T00:00:00Z",
"plannedDate": "2024-01-01",
"plannedTime": "string"
}