DemandFlow Support Centre

CONNECTION: Connection

The CONNECTION entity stores connections. Physical cable connection between two port instances, with media type, routing path, and test results.

Default definition. This article describes the default CONNECTION 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 CONNECTION.

Entity properties

Property	Value
Entity code	`CONNECTION`
Display name	Connection
Plural	Connections
Level	285

Use cases

CONNECTION models a physical cable or link between two COMPPORTINV port instances (portA and portB). It operates at the physical layer, tracking the actual cable infrastructure rather than logical services (which are handled by LOGICALCONNECTION).

Fields

Connection Details

Field	Type	Required	Notes
`name`	text	Yes	Auto-generated or custom identifier
`connectionType`	enum	Yes	Immediate: Direct physical connection \| End-to-End: Logical connection through intermediaries. Valid ids: `1` (Immediate), `2` (End-to-End).
`mediaType`	enum	Yes	Media Type. Valid ids: `1` (Copper - Cat5e), `2` (Copper - Cat6), `3` (Copper - Cat6a), `4` (Copper - Cat7), `5` (Copper - Cat8), `6` (Fiber - Single Mode), `7` (Fiber - Multi Mode OM3), `8` (Fiber - Multi Mode OM4), `9` (Fiber - Multi Mode OM5), `10` (Coaxial), `11` (DAC - Direct Attach Copper), `12` (AOC - Active Optical Cable), `13` (Power), `14` (Other).
`protocol`	enum		Protocol/Interface. Valid ids: `1` (Ethernet - 1G), `2` (Ethernet - 10G), `3` (Ethernet - 25G), `4` (Ethernet - 40G), `5` (Ethernet - 100G), `6` (Ethernet - 400G), `7` (Fibre Channel - 8G), `8` (Fibre Channel - 16G), `9` (Fibre Channel - 32G), `10` (InfiniBand), `11` (Serial Console), `12` (Power), `13` (Analog Voice), `14` (E1/T1), `15` (Other).
`status`	enum	Yes	Status. Valid ids: `1` (Active), `2` (Planned), `3` (Failed), `4` (Decommissioned), `5` (Testing).
`logicalConnection`	reference → `LOGICALCONNECTION`		The end-to-end logical connection this cable is part of
`pathOrder`	number		Position in the logical connection path (1 = first hop)

Endpoints

Field	Type	Required	Notes
`portA`	reference → `COMPPORTINV`	Yes	Port A
`portB`	reference → `COMPPORTINV`	Yes	Port B
`direction`	enum		Direction. Valid ids: `1` (Bidirectional), `2` (A to B), `3` (B to A).
`isActive`	boolean		Is this connection currently passing traffic
`isRedundant`	boolean		Redundant Path

Cable Details

Field	Type	Notes
`cableId`	text	Cable ID/Label
`length`	number	Length (meters)
`color`	text	Cable Color
`manufacturer`	reference → `VEN`	Cable Manufacturer
`partNumber`	text	Part Number
`installDate`	date	Installation Date
`testDate`	date	Last Test Date

Routing

Field	Type	Notes
`routingPath`	text (multi-line)	Physical path of cable (e.g., Rack A1 → Under Floor → Rack B3)
`intermediatePoints`	text (multi-line)	Patch panels, junction boxes, etc.
`cablePathway`	reference → `CABLEPATHWAY`	Primary pathway this cable is routed through
`cableTray`	text	Free-text reference - use Cable Pathway lookup above for new entries

Test Results

Field	Type	Notes
`testResult`	enum	Test Status. Valid ids: `1` (Pass), `2` (Fail), `3` (Marginal), `4` (Not Tested).
`attenuation`	number	Attenuation (dB)
`insertionLoss`	number	Insertion Loss (dB)
`returnLoss`	number	Return Loss (dB)
`crosstalk`	number	Crosstalk (dB)

Utilization

Field	Type	Notes
`bandwidth`	number	Bandwidth (Gbps)
`utilization`	text	Utilization %. Read-only
`service`	text	Service/Circuit ID

Notes & Documentation

Field	Type	Required	Notes
`notes`	text (multi-line)		Notes
`diagram`	text (URL)		Diagram Link

Documents

Field	Type	Required	Notes
`files`	file		Cable Photos

Relationships

Lookups: logicalConnection points at a LOGICALCONNECTION record; portA points at a COMPPORTINV record; portB points at a COMPPORTINV record; manufacturer points at a VEN record; cablePathway points at a CABLEPATHWAY record.

Creating a Connection via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "CONNECTION",
  "level":    285,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name":        "Example value",
  "connectionType": "1",
  "mediaType":   "1",
  "status":      "1"
}

Listing Connections

GET /v1/entities/CONNECTION/SUB

DemandFlow Support Centre

CONNECTION: Connection

CONNECTION: Connection

Entity properties

Use cases

Fields

Relationships

Creating a Connection via the API

Listing Connections

See also

Was this article helpful?