PORTTYPE: Port type
The PORTTYPE entity represents classification type for ports, providing a controlled taxonomy for port categorisation across components.
PORTTYPE 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 PORTTYPE.Entity properties
| Property | Value |
|---|---|
| Entity code | PORTTYPE |
| Display name | Port type |
| Plural | Port types |
| Level | 100000 |
Use cases
PORTTYPE is a simple lookup entity that provides a controlled vocabulary for classifying ports on components and assets. It serves the same purpose for ports that COMPTYPE serves for components and SUBCOMPTYPE for subcomponents - a centrally managed taxonomy that can be referenced by COMPPORT and COMPPORTINV records. Common port types would include Ethernet RJ45, SFP, SFP+, QSFP28, USB, serial console, power IEC C13/C14, fiber LC/SC, etc. The minimal structure (name + description) is standard for a lookup entity. Having port types as a separate entity rather than an inline select list means organisations can define custom port types for specialised equipment and maintain consistency across the component catalogue and asset inventory.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
description | text (multi-line) | Description. |
Relationships
- No declared relationships in the default definition.
Creating a Port type via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "PORTTYPE",
"level": 100000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"description": "Long description text."
}Listing PORTTYPE records
# All port types in your tenant
GET /v1/entities/PORTTYPE/SUB