WORKFLOW: Workflow
Defines a set of statuses and their valid transitions. Kanban boards and work items reference a workflow to determine their columns and enforce movement rules.
WORKFLOW definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches WORKFLOW.Entity properties
| Property | Value |
|---|---|
| Entity code | WORKFLOW |
| Display name | Workflow |
| Plural | Workflows |
| Level | 11100 |
Use cases
Defines a set of statuses and their valid transitions. Kanban boards and work items reference a workflow to determine their columns and enforce movement rules.
A workflow is a reusable status lifecycle definition. The statuses relatedlist defines the ordered list of statuses (each with an id, name, colour, and icon). The transitions relatedlist defines which status-to-status moves are allowed. if no transitions are defined, all moves are permitted (open workflow). If transitions exist, only the defined from→to pairs are valid (enforced workflow). The defaultStatusId field identifies which status new items should start in. Workflows are referenced by kanban boards (for column definitions) and by work items (for current position and transition validation).
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
description | text (multi-line) | Description. | |
active | boolean | Active. | |
defaultStatusId | reference → WORKFLOWSTATUS | The status ID that new items start in (must match an ID from the Statuses list) | |
enforceTransitions | boolean | When enabled, items can only move between statuses defined in the Transitions list. When disabled, any status change is allowed. |
Relationships
- Lookups:
defaultStatusIdpoints at aWORKFLOWSTATUSrecord. - Related lists:
WORKFLOWSTATUSvia comboKey (format:SUB|WORKFLOW);WORKFLOWTRANSITIONvia comboKey (format:SUB|WORKFLOW).
Creating a Workflow via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "WORKFLOW",
"level": 11100,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"description": "Example text"
}Listing Workflows
GET /v1/entities/WORKFLOW/SUB