DemandFlow Support Centre

SOFTWARE: Software

The SOFTWARE entity: Software product catalogue entry with version, classification, licensing model, system requirements, and support info.

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

Entity properties

Property	Value
Entity code	`SOFTWARE`
Display name	Software
Plural	Software
Level	300

Use cases

SOFTWARE is the catalogue entity for the software management domain, analogous to COMP in the hardware world. It defines WHAT a software product IS rather than tracking where it is installed (that is SOFTWAREINSTALL) or how it is licensed (LICENSE). The General panel captures product identity: name, displayName (commercial name), version, edition, vendor (VEN), and description.

Classification provides a rich taxonomy: category (OS through Firmware), subcategory, deployment type (On-Premise/SaaS/Hybrid/Container/Virtual Appliance), supported platforms, and CPU architectures. Lifecycle fields track the vendor's support timeline (releaseDate, endOfSale, endOfSupport, endOfLife) with approval (isApproved) and criticality (isCritical) flags for internal governance. The Requirements panel captures minimum and recommended hardware specs plus dependencies and incompatibilities - essential for deployment planning.

Fields

Software Information

Field	Type	Required	Notes
`name`	text	Yes	Software Name
`displayName`	text		Full commercial name
`version`	text	Yes	Version
`edition`	text		e.g., Professional, Enterprise, Standard
`vendor`	reference → `VEN`	Yes	Vendor
`description`	text (multi-line)		Description
`msSkuId`	text		Microsoft SKU identifier from Entra ID

Classification

Field	Type	Required	Notes
`category`	enum	Yes	Category Valid ids: `1` (Operating System), `2` (Database), `3` (Web Server), `4` (Application Server), `5` (Development Tool), `6` (Security Software), `7` (Backup Software), `8` (Monitoring Tool), `9` (Virtualization), `10` (Container Platform), `11` (Business Application), `12` (Productivity Suite), `13` (Utility), `14` (Driver), `15` (Firmware), `16` (Other).
`subcategory`	text		Subcategory
`deploymentType`	enum		Deployment Type Valid ids: `1` (On-Premise), `2` (Cloud (SaaS)), `3` (Hybrid), `4` (Container), `5` (Virtual Appliance).
`platform`	enum		Platform Valid ids: `1` (Windows), `2` (Linux), `3` (macOS), `4` (Unix), `5` (iOS), `6` (Android), `7` (Web-based), `8` (Cross-platform).
`architecture`	enum		Architecture Valid ids: `1` (x86 (32-bit)), `2` (x64 (64-bit)), `3` (ARM), `4` (ARM64), `5` (Universal).

Lifecycle

Field	Type	Notes
`releaseDate`	date	Release Date
`endOfSale`	date	End of Sale
`endOfSupport`	date	End of Support
`endOfLife`	date	End of Life
`status`	enum	Status Valid ids: `1` (Current), `2` (Deprecated), `3` (Obsolete), `4` (Beta), `5` (Preview).
`isApproved`	boolean	Approved for Use
`isCritical`	boolean	Business Critical

System Requirements

Field	Type	Notes
`minCpu`	text	Minimum CPU
`minRam`	number	Minimum RAM (GB)
`minStorage`	number	Minimum Storage (GB)
`recommendedCpu`	text	Recommended CPU
`recommendedRam`	number	Recommended RAM (GB)
`recommendedStorage`	number	Recommended Storage (GB)
`networkRequirements`	text (multi-line)	Network Requirements

Dependencies

Field	Type	Notes
`prerequisites`	text (multi-line)	Required software or components
`incompatibilities`	text (multi-line)	Known Incompatibilities
`requiredPorts`	text (multi-line)	Network ports that must be open

License Model

Field	Type	Required	Notes
`licenseType`	enum	Yes	License Type Valid ids: `1` (Perpetual), `2` (Subscription), `3` (Open Source), `4` (Freeware), `5` (Trial/Evaluation), `6` (OEM).
`licenseMetric`	enum		License Metric Valid ids: `1` (Per User), `2` (Per Device), `3` (Per Core), `4` (Per CPU), `5` (Per Server), `6` (Concurrent Users), `7` (Site License), `8` (Enterprise Agreement), `9` (Consumption Based).
`canBeShared`	boolean		License allows sharing between users
`requiresActivation`	boolean		Requires Activation

Compliance

Field	Type	Notes
`licenseName`	text	e.g., GPL, MIT, Apache 2.0, Commercial
`eulaUrl`	text (URL)	EULA URL
`complianceNotes`	text (multi-line)	Special compliance requirements
`auditRequired`	boolean	Audit Required
`restrictedCountries`	text	Export Restrictions

Support Information

Field	Type	Notes
`supportVendor`	reference → `VEN`	May differ from software vendor
`supportLevel`	enum	Support Level Valid ids: `1` (Basic), `2` (Standard), `3` (Premium), `4` (24x7), `5` (Community Only), `6` (None).
`supportPhone`	text	Support Phone
`supportEmail`	text	Support Email
`supportPortalUrl`	text (URL)	Support Portal

Documentation

Field	Type	Notes
`documentationUrl`	text (URL)	Documentation URL
`installGuideUrl`	text (URL)	Installation Guide
`apiDocumentationUrl`	text (URL)	API Documentation
`knowledgeBaseUrl`	text (URL)	Knowledge Base
`releaseNotesUrl`	text (URL)	Release Notes

Cost Information

Field	Type	Notes
`listPrice`	number	List Price
`pricingUnit`	text	e.g., per user/month, per core
`pricingNotes`	text (multi-line)	Pricing Notes

Relationships

Lookups: vendor points at a VEN record; supportVendor points at a VEN record.
Related lists: LICENSE (format comboKeyEntity), SOFTWAREINSTALL (format software).

Creating a Software via the API

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

{
  "entity":   "SOFTWARE",
  "level":    300,
  "comboKey": "SUB:|ENT:",
  "name":    "Example name",
  "version":    "Example value",
  "vendor":    "",
  "category":    1
}

Listing Software records

GET /v1/entities/SOFTWARE/SUB

DemandFlow Support Centre

SOFTWARE: Software

SOFTWARE: Software

Entity properties

Use cases

Fields

Relationships

Creating a Software via the API

Listing Software records

See also

Was this article helpful?