SCENARIO: Scenario
The SCENARIO entity: A named what-if variant of a portfolio's project mix, capturing which projects are included and their adjusted budgets / timelines / priorities for comparison against baseline.
Default definition. This article describes the default
SCENARIO 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 SCENARIO.Entity properties
| Property | Value |
|---|---|
| Entity code | SCENARIO |
| Display name | Scenario |
| Plural | Scenarios |
| Level | 495 |
Use cases
SCENARIO is a child of PORT (comboKey SUB|PORT). Each SCENARIO holds a snapshot-style set of SCENARIOLINE records. one per project.
which the planner toggles in/out and tweaks. Scenarios are non-destructive: they never change the underlying PJ records, only surface comparative totals.
Fields
Basic Information
| Field | Type | Required | Notes |
|---|---|---|---|
ref | text | Read-only. Ref | |
name | text | Yes | Scenario Name |
description | text (multi-line) | Description | |
status | enum | Yes | Status Valid ids: draft (Draft), active (Active), approved (Approved), archived (Archived). |
Snapshot
| Field | Type | Required | Notes |
|---|---|---|---|
baselineDate | date | Point-in-time the scenario was branched from | |
ownerId | reference → user | Read-only. Created By |
Additional panels
- 1 dashboard panel rendered from custom functions.
Relationships
- Lookups:
ownerIdpoints at a user. - Related lists:
SCENARIOLINE(formatSUB|PORT|SCENARIO). - Parent: typically a child of
PORTvia comboKey.
Creating a Scenario via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "SCENARIO",
"level": 495,
"comboKey": "SUB:|PORT:|ENT:",
"name": "Example name",
"status": "draft",
"description": "Example Description",
"baselineDate": "2026-01-01"
} Listing Scenarios records
GET /v1/entities/SCENARIO/SUBGET /v1/entities/SCENARIO/SUB:<your-sub-id>|PORT:<parent-id>