API Docs / Schemas / WorkflowStepDetailsDto

WorkflowStepDetailsDto

Details about a specific workflow step when a TaskItemDto represents a workflow step view

Properties

Name Type Description
stepCodeAndNameDto
descriptionstring

The description of the workflow step

The description of the workflow step

workflowGroupCodeAndNameDto
groupDeadlinestring

The deadline for the workflow group containing this step

The deadline for the workflow group containing this step

statusenum

NotStarted InProgress Blocked Completed Skipped

NotStarted InProgress Blocked Completed Skipped

isOverdueboolean

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)

blockedReasonstring

The reason this step is blocked. Only populated when Status is Blocked.

The reason this step is blocked. Only populated when Status is Blocked.

completedDatestring

When this workflow step was completed (if applicable)

When this workflow step was completed (if applicable)

assignedToCodeAndNameDto
canStartboolean

Indicates whether this step can be started based on its dependency requirements

Indicates whether this step can be started based on its dependency requirements

JSON Example

{
  "step": {
    "code": "string",
    "name": "string"
  },
  "description": "string",
  "workflowGroup": {
    "code": "string",
    "name": "string"
  },
  "groupDeadline": "2024-01-01T00:00:00Z",
  "status": "NotStarted"
}

Contained in Schemas