EPIC: Epic
A large body of work grouping related user stories, with roadmap planning, dependencies, and progress tracking.
EPIC 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 EPIC.Entity properties
| Property | Value |
|---|---|
| Entity code | EPIC |
| Display name | Epic |
| Plural | Epics |
| Level | 500 |
Use cases
EPIC represents a large feature or initiative that is too big to deliver in a single sprint, broken down into user stories (US). It links to a portfolio (PORT) and project (PJ) for strategic alignment. The ai:true and context.getEpicData flags enable AI-assisted analysis of epic data. User stories are related via a lookup relationship (property: epic) rather than comboKey, allowing stories to be reassigned between epics. The dependency model uses multiselect (dependsOn) for forward dependencies and reverse lookups for blocking relationships, supporting roadmap visualisation via the Gantt panel. Story points and progress percentage (readonly) are aggregated from child user stories. The timeline viewOption enables roadmap-style viewing alongside the standard grid. Budget tracking is included because epics often represent fundable work packages.
Fields
Epic Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Epic Name. |
description | text (multi-line) | Epic Description. Example: Describe the high-level business objective or feature. | |
businessCase | text (multi-line) | Business Case. Example: Why is this epic important? What value does it deliver?. | |
successCriteria | text (multi-line) | Success Criteria. Example: How will we measure the success of this epic?. | |
priority | enum | Yes | Valid ids: critical (Critical), high (High), medium (Medium), low (Low). |
epicType | enum | Valid ids: feature (Feature), enhancement (Enhancement), technical (Technical), research (Research), infrastructure (Infrastructure). | |
tags | array of text | Tags. |
Planning & Tracking
| Field | Type | Required | Notes |
|---|---|---|---|
status | enum | Yes | Valid ids: proposed (Proposed), approved (Approved), inprogress (In Progress), delivered (Delivered), cancelled (Cancelled), onhold (On Hold). |
portfolio | reference → PORT | Portfolio. | |
project | reference → PJ | Project. | |
epicOwner | reference → user | Yes | Epic Owner. |
stakeholders | array of references → user | Stakeholders. | |
startDate | date | Start Date. | |
targetDate | date | Target Completion. | |
actualCompletionDate | date | Actual Completion. |
Sizing & Progress
| Field | Type | Required | Notes |
|---|---|---|---|
estimatedStoryPoints | number | Estimated Story Points. | |
actualStoryPoints | number | Actual Story Points. Read only. | |
progressPercentage | number | Progress %. Read only. | |
budget | number | Budget. |
External Links
| Field | Type | Required | Notes |
|---|---|---|---|
confluenceUrl | text (URL) | Confluence Page. | |
jiraUrl | text (URL) | Jira Epic. | |
designUrl | text (URL) | Design Documents. | |
prototypeUrl | text (URL) | Prototype. | |
analyticsUrl | text (URL) | Analytics Dashboard. |
Attachments
| Field | Type | Required | Notes |
|---|---|---|---|
documents | file | Allowed types: *. |
Activity timeline panel attached.
Additional panels: gantt.
Relationships
- Lookup:
portfolio(reference →PORT). - Lookup:
project(reference →PJ). - Related list:
US, linked by child fieldepic. - Related list:
EPIC, multi-select fielddependsOnon the parent. - Related list:
EPIC, reverse ofdependsOn.
Creating a Epic via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "EPIC",
"level": 500,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"priority": "critical",
"status": "proposed",
"epicOwner": ""
} Listing Epics records
GET /v1/entities/EPIC/SUB:<your-sub-id>