Skip to content
  • There are no suggestions because the search field is empty.

Minimum Data Schema for Licenseware API Integrations

Learn about Licenseware’s minimum data schema for API integrations. Understand the standardized data fields required to support accurate and reliable software license analysis across various vendors and technologies.

When integrating with Licenseware, it is important to align with our standardized data schema. This schema enables efficient and accurate software license analysis by providing a structured set of data points that are applicable across multiple software vendors and license types.

The data points listed below represent the common fields that Licenseware’s applications consume. Depending on the type of analysis (e.g., software inventory, infrastructure, Microsoft, Oracle), different subsets of this data may be required. However, providing as much of this data as possible will improve the accuracy, reliability, and completeness of the analysis.

Minimum Data Schema

Field Name Data Type Description Format / Examples
device_name String Unique device identifier "SERVER01.company.com", "LAPTOP-USER123"
software_vendor String Software publisher/vendor "Microsoft", "Oracle", "Adobe"
software_name String Software product name "Windows Server", "Java Runtime", "Acrobat Pro"
operating_system String Operating system "Windows Server 2019", "Red Hat Linux 8"
software_version String Software version or release "8.0.1210.13", "2019", "21.0.3"
last_used_date Date Last usage date "20.06.2023" (dd.mm.yyyy)
processor_count Integer Physical processor count 1, 2, 4, 8
core_count Integer Total physical cores 4, 8, 16, 32
logical_processor_count Integer Logical processors or threads 8, 16, 32, 64
cpu_model String Processor model "Intel Xeon E5-2680", "AMD EPYC 7742"
device_manufacturer String Hardware manufacturer "Dell", "HP", "Lenovo", "VMware"
device_model String Hardware model "PowerEdge R740", "ProLiant DL380"
is_virtual Boolean Indicates if the machine is virtual TRUE, FALSE
virtualization_type String Virtualization technology "VMware", "Hyper-V", "KVM", "Xen"
user_name String Associated user "john.doe", "admin"
source_system_id String

Source system identifier (internal reference)

 "CMDB-12345", "INV-67890"
host_name String If device is virtual, the hosts unique identifier "SERVER01.company.com", ""
cluster_name String If device is in cluster, the clusters unique identifier "Cluster3"
 

About This Schema

  • This schema is designed to be flexible. Different Licenseware applications (e.g., Software Inventory Management, Oracle Analysis, Microsoft Analysis, Infrastructure Analysis) require different subsets of this data.

  • As an example, for software inventory management, only basic fields like device_name, software_vendor, software_name, and software_version may be necessary.

  • For infrastructure or processor-based licensing models (e.g., Oracle, Microsoft), fields like core_count, processor_count, logical_processor_count, and virtualization_type become relevant.

Integration Guidance

  • While not every data point is required for every analysis, providing as much data as possible enhances accuracy and reduces follow-up data validation.

  • Systems commonly used for integration include CMDBs, inventory management platforms, or custom datasets.

  • The expectation is to map your system’s data fields to this schema prior to integration via the Licenseware API.

Need Assistance?

For guidance on mapping, API integration, or to clarify which fields apply to a specific analysis type, please reach out to the Licenseware support or solutions engineering team.