DemandFlow Support Centre

LOGICALCONNECTION: Logical Connection

Logical or service-level network connection with L2/L3/MPLS configuration, SLA metrics, and endpoint mapping.

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

Entity properties

Property	Value
Entity code	`LOGICALCONNECTION`
Display name	Logical Connection
Plural	Logical Connections
Level	290

Use cases

LOGICALCONNECTION models network services and logical circuits that ride over physical CONNECTION infrastructure. While CONNECTION tracks individual cables, LOGICALCONNECTION represents the service layer: VLANs, MPLS VPNs, internet transit, SD-WAN overlays, and similar constructs that span multiple physical links. The serviceType field covers the full range of modern network services from simple VLANs through MPLS L3VPN/L2VPN/E-Line, IPSec VPN, GRE tunnels, SD-WAN, LAGs, dark fiber, and wavelength services.

Fields

Service Details

Field	Type	Required	Notes
`name`	text	Yes	Unique service identifier
`description`	text (multi-line)		Description
`serviceType`	enum	Yes	Service Type Valid ids: `1` (VLAN), `2` (VLAN Trunk), `3` (VXLAN), `4` (MPLS L3VPN), `5` (MPLS L2VPN (VPLS)), `6` (MPLS E-Line), `7` (Internet Transit), `8` (Private Peering), `9` (IPSec VPN), `10` (GRE Tunnel), `11` (SD-WAN Overlay), `12` (Link Aggregation (LAG)), `13` (Layer 2 Circuit), `14` (Dark Fiber), `15` (Wavelength Service).
`topology`	enum	Yes	Topology Valid ids: `1` (Point-to-Point), `2` (Multipoint (Hub & Spoke)), `3` (Any-to-Any (Full Mesh)), `4` (Partial Mesh), `5` (Ring).
`status`	enum	Yes	Status Valid ids: `1` (Active), `2` (Planned), `3` (Provisioning), `4` (Failed), `5` (Maintenance), `6` (Decommissioned).

Service Level

Field	Type	Required	Notes
`bandwidth`	number	Yes	Bandwidth (Mbps)
`cir`	number		Committed Information Rate
`qosClass`	enum		QoS Class Valid ids: `1` (Best Effort), `2` (Business), `3` (Premium), `4` (Real-time), `5` (Mission Critical).
`sla`	enum		SLA Level Valid ids: `1` (Standard (99.0%)), `2` (Enhanced (99.5%)), `3` (Premium (99.9%)), `4` (Ultra (99.95%)), `5` (Carrier Grade (99.999%)).
`redundancy`	enum		Redundancy Valid ids: `1` (None), `2` (Active/Standby), `3` (Active/Active), `4` (N+1), `5` (Geographically Diverse).

Layer 2 Configuration

Field	Type	Notes
`vlanId`	text	Single VLAN or range (e.g., 100 or 100-200)
`vni`	number	VXLAN Network Identifier
`dot1q`	boolean	802.1Q Tagged
`qinq`	boolean	Q-in-Q (802.1ad)
`outerVlan`	number	Outer VLAN (S-Tag)
`innerVlan`	number	Inner VLAN (C-Tag)
`mtu`	number	MTU Size
`jumboFrames`	boolean	Jumbo Frames

Layer 3 Configuration

Field	Type	Notes
`vrf`	text	VRF Name
`rd`	text	Route Distinguisher
`rtImport`	text	Route Target Import
`rtExport`	text	Route Target Export
`ipSubnet`	text	CIDR notation (e.g., 10.0.0.0/24)
`gateway`	text	Default Gateway
`asn`	number	AS Number
`bgpPeers`	text (multi-line)	BGP Peers

MPLS Configuration

Field	Type	Notes
`mplsEnabled`	boolean	MPLS Enabled
`lspName`	text	Label Switched Path name
`labelRange`	text	Label Range
`trafficEngineering`	boolean	Traffic Engineering
`fastReroute`	boolean	Fast Reroute
`ldpEnabled`	boolean	LDP Enabled
`rsvpEnabled`	boolean	RSVP-TE Enabled

Service Labels

Field	Type	Notes
`vcId`	number	VC ID (Pseudowire)
`pwType`	enum	Pseudowire Type Valid ids: `1` (Ethernet), `2` (Ethernet VLAN), `3` (PPP), `4` (HDLC), `5` (Frame Relay).
`controlWord`	boolean	Control Word
`flowLabel`	boolean	Flow Label

SLA Metrics

Field	Type	Notes
`latency`	number	Latency (ms) Read only.
`jitter`	number	Jitter (ms) Read only.
`packetLoss`	number	Packet Loss (%) Read only.
`availability`	gauge	Availability (%) Read only.

Utilization

Field	Type	Notes
`ingressRate`	number	Ingress Rate (Mbps) Read only.
`egressRate`	number	Egress Rate (Mbps) Read only.
`peakUtilization`	gauge	Peak Utilization (%) Read only.
`averageUtilization`	gauge	Average Utilization (%) Read only.

Service Documentation

Field	Type	Notes
`customer`	reference → `CLIENT`	Customer
`orderNumber`	text	Order Number
`circuitId`	text	Circuit ID
`activationDate`	date	Activation Date
`contractEndDate`	date	Contract End Date
`notes`	text (multi-line)	Notes
`diagram`	text (URL)	Network Diagram

Relationships

Lookups: customer points at a CLIENT record.
Related lists: LOGICALENDPOINT, CONNECTION.

Creating a Logical Connection via the API

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

{
  "entity":   "LOGICALCONNECTION",
  "level":    290,
  "comboKey": "SUB:<your-sub-id>|ENT:",
  "name": "Example",
  "serviceType": "1",
  "topology": "1",
  "status": "1"
}

Listing Logical Connections records

# All logical connections in your tenant
GET /v1/entities/LOGICALCONNECTION/SUB

DemandFlow Support Centre

LOGICALCONNECTION: Logical Connection

LOGICALCONNECTION: Logical Connection

Entity properties

Use cases

Fields

Relationships

Creating a Logical Connection via the API

Listing Logical Connections records

See also

Was this article helpful?