WorkflowDto

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

Properties

Name	Type	Description
code	string	Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
Stable identifier. For library-shipped items this is the library code; for tenant-imported items this is the tenant entity's own code.
name	string	Display name shown to users in lists, dialogs, and the import browser.
Display name shown to users in lists, dialogs, and the import browser.
description	string	Optional human-readable summary of what this entity is for.
Optional human-readable summary of what this entity is for.
libraryCode	string	The Code of the library template this entity was imported from, or null if the entity is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".
The Code of the library template this entity was imported from, or null if the entity is not from the library. Read-only — cannot be changed once set. Example: "vat_returns".
libraryStatus	enum	Describes a library-imported entity's relationship to its source library template. NotFromLibrary UpToDate LocallyModified LibraryUpdated
Describes a library-imported entity's relationship to its source library template. NotFromLibrary UpToDate LocallyModified LibraryUpdated
isImported	boolean	True if the tenant has already imported this library item.
True if the tenant has already imported this library item.
deprecated	boolean	True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
True if this library item has been retired. Deprecated items are hidden from the import browser (so new tasks cannot be created from them) but remain available for revert-to-library on existing imports.
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
hasAutoExecutingStepsWithNoDependencies	boolean	Whether this workflow contains any auto-executing steps with no dependencies. These steps will execute automatically when the workflow is applied to a task.
Whether this workflow contains any auto-executing steps with no dependencies. These steps will execute automatically when the workflow is applied to a task.
requiresClient	boolean	Whether this workflow requires a client to be associated with the task. True if any email step uses client tokens in content or sends to client contact recipients.
Whether this workflow requires a client to be associated with the task. True if any email step uses client tokens in content or sends to client contact recipients.

JSON Example

{
  "code": "string",
  "name": "string",
  "description": "string",
  "libraryCode": "string",
  "libraryStatus": "NotFromLibrary"
}

Used By Operations

Contained in Schemas

WorkflowDtoPagedResult