PROGGATE: Programme Gate
The PROGGATE entity represents a gate evaluation instance recording the results of a governance checkpoint applied to a specific programme.
Default definition. This article describes the default
PROGGATE 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 PROGGATE.Entity properties
| Property | Value |
|---|---|
| Entity code | PROGGATE |
| Display name | Programme Gate |
| Plural | Programme Gates |
| Level | 100010 |
Use cases
PROGGATE records are children of PROG (comboKey format SUB|PROG). Each record represents one gate template being evaluated against a programme. The results JSON property contains the item-by-item evaluation snapshot. The attempts JSON array stores previous evaluation runs for audit trail and re-evaluation history. Created and updated by the runProgGateReview toolbar function on PROG. Status transitions: Pending (initial), Failed (checks not met), Passed (all mandatory checks pass), Overridden (mandatory failures overridden by authorised user with justification).
Fields
Gate Result
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Gate Name. Read-only. | |
templateName | text | Template. Read-only. | |
templateId | text | Template ID. Read-only. | |
status | enum | Status. Valid ids: Pending (Pending), Passed (Passed), Failed (Failed), Overridden (Overridden). | |
score | number | Score (%). Read-only. | |
requestedBy | reference → user | Requested By. Read-only. | |
requestedDate | date | Requested Date. Read-only. | |
approvedBy | reference → user | Approved By. Read-only. | |
approvedDate | date | Approved Date. Read-only. | |
overrideJustification | text (multi-line) | Override Justification. Read-only. |
Relationships
- Embedded arrays:
array,array. Each entry is a sub-record stored inline on this object.
Creating a Programme Gate via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "PROGGATE",
"level": 100010,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example"
}Listing PROGGATE records
# All programme gates in your tenant
GET /v1/entities/PROGGATE/SUB