DEFINITION: Object definition
The meta-definition entity that defines the structure and editing interface for all other object definitions.
DEFINITION 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 DEFINITION.Entity properties
| Property | Value |
|---|---|
| Entity code | DEFINITION |
| Display name | Object definition |
| Plural | Object definitions |
| Level | 11000 |
Use cases
Self-referential meta-definition - this is the definition that defines how to edit other definitions within the app. Has isObjectDefinition: true flag which triggers special handling: the 'definition' property is stored as a JSON string and deserialized for editing. Two-column layout: left (20%) has all top-level object properties (name, plural, menuItem, menuGroup, level, icon via iconchooserfw, description, view type, list type, sort fields, feature flags like bulkActions/ai/autoOpen/kanban/import/export/permissions/liveUpdates/massive, crunchproperty, comboFilterAdd, cardTemplate); right (80%) uses the panellist row type to render the definition's panel array as a reorderable drag-drop list, enabling visual editing of the panel/column/row/field hierarchy. The 'remaining' and 'panelData' arrays store documentation about unhandled properties and panel property usage statistics. Central to the definition-driven architecture.
Fields
Basics
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
plural | text | Yes | Plural name of the object. |
menuItem | text | Yes | Menu id. Example: Unique ID for the menu and permissions. |
menuGroup | text | Set this to a Menu Group ID to place this object inside that sidebar group. | |
level | number | Entity grouping hierarchy level. | |
icon | text (FA icon class) | Yes | Default menu icon. |
description | text (multi-line) | Description. | |
view | enum | Yes | Valid ids: complex (Complex). |
list | enum | Default entity presentation when you show a list of objects. Valid ids: grid (List grid), kanban (Kanban), dataview (Dataview blocks), projectcontainers (Project container (Portfolio)), calendar (Calendar). | |
sort | text | The ID of a field to sort the default List by. | |
datasort | text | The ID of a field to sort the default List by. | |
kanban | boolean | Open to Kanban view. | |
bulkActions | boolean | Bulk actions. | |
hideNew | boolean | Hides the New menu item on the object list screen. | |
ai | boolean | AI function. | |
autoOpen | boolean | Auto open on creation. | |
css | text | Any required CSS classes. | |
import | boolean | Import items. | |
export | boolean | Export items from list. | |
permissions | boolean | Permissions required. | |
liveUpdates | boolean | Live updates to objects. | |
massive | boolean | Massive data collection. | |
permissionsFunc | text | Name of a permissions check function | |
loader | text | Name of an object loader function | |
load | text | Comma separated list of fields to load | |
crunchproperty | text | Crunch property. | |
comboFilterAdd | text | Default comboKey config. | |
cardTemplate | text (multi-line) | Card HTML template. | |
extends | text | Entity code of the base entity this overlays (e.g. COM). Sets this as an overlay entity. | |
extendedBy | text | Comma-separated entity codes that overlay this entity (e.g. VEN,CLIENT). |
Additional panels: panellist.
Relationships
- No declared relationships in the default definition.
Creating a Object definition via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "DEFINITION",
"level": 11000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"plural": "Example value",
"menuItem": "Example value",
"icon": "Example value"
}Listing Object definitions records
GET /v1/entities/DEFINITION/SUB:<your-sub-id>