WorkflowDto
DTO for workflow templates, exposing only codes and structured data (never DB IDs).
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The unique code for this workflow |
The unique code for this workflow | ||
| name | string | The name of the workflow |
The name of the workflow | ||
| description | string | Optional description explaining the workflow's purpose |
Optional description explaining the workflow's purpose | ||
| deadlineRelativeTo | enum | DueDate StartDate |
DueDate StartDate | ||
| groupCount | integer | Total number of groups in this workflow |
Total number of groups in this workflow | ||
| stepCount | integer | Total number of steps across all groups in this workflow |
Total number of steps across all groups in this workflow | ||
| groups | array of WorkflowGroupDto | The workflow groups containing steps |
The workflow groups containing steps | ||
| libraryCode | string | Library code this workflow was imported from (null if not from library) |
Library code this workflow was imported from (null if not from library) | ||
| matchesLibraryContents | boolean | 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
-
POST
Create Workflow
/tenants/{tenant}/workflows
-
GET
Get Workflow
/tenants/{tenant}/workflows/{code}
-
PUT
Update Workflow
/tenants/{tenant}/workflows/{code}
-
GET
Library Item
/tenants/{tenant}/workflows/library/{code}
-
POST
Import from Library
/tenants/{tenant}/workflows/library/{libraryCode}/import
-
POST
Generate Workflow
/tenants/{tenant}/workflows/generate