API Docs / Schemas / WorkflowDto

WorkflowDto

DTO for workflow templates, exposing only codes and structured data (never DB IDs).

Properties

Name Type Description
codestring

The unique code for this workflow

The unique code for this workflow

namestring

The name of the workflow

The name of the workflow

descriptionstring

Optional description explaining the workflow's purpose

Optional description explaining the workflow's purpose

deadlineRelativeToenum

DueDate StartDate

DueDate StartDate

groupCountinteger

Total number of groups in this workflow

Total number of groups in this workflow

stepCountinteger

Total number of steps across all groups in this workflow

Total number of steps across all groups in this workflow

groupsarray of WorkflowGroupDto

The workflow groups containing steps

The workflow groups containing steps

libraryCodestring

Library code this workflow was imported from (null if not from library)

Library code this workflow was imported from (null if not from library)

matchesLibraryContentsboolean

Whether workflow matches library version (null=not from library, true=matches, false=modified)

Whether workflow matches library version (null=not from library, true=matches, false=modified)

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "deadlineRelativeTo": "DueDate",
  "groupCount": 0
}

Used By Operations

Contained in Schemas