COMPPORT: Port
The COMPPORT entity stores ports. Catalogue-level port definition on a component, specifying port name, reference, and MAC address template.
Default definition. This article describes the default
COMPPORT 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 COMPPORT.Entity properties
| Property | Value |
|---|---|
| Entity code | COMPPORT |
| Display name | Port |
| Plural | Ports |
| Level | 100000 |
Use cases
COMPPORT is the catalogue side of the port dual model (catalogue: COMPPORT, inventory: COMPPORTINV). It defines the ports that exist on a component template (COMP or SUBCOMP) before that component is physically deployed.
Fields
Basic Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name |
ref | text | Reference | |
description | text (multi-line) | Description |
Network detail
| Field | Type | Required | Notes |
|---|---|---|---|
mac | text | MAC address |
Relationships
- No declared relationships in the default definition.
Creating a Port via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "COMPPORT",
"level": 100000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example value",
"description": "Example value"
}Listing Ports
GET /v1/entities/COMPPORT/SUB