Software

Refer to the Retrieval of software inventory (v2) to know about the BigFix Inventory computers (hardware) API v2.

Example of API request URL used to transfer computers data to ServiceNow:

[BFI_URL]/api/sam/v2/software_instances?token=[FILTERED]&offset=0&limit=100000&order[]=computer_id&criteria={"and":[["is_present","=","1"],["is_suppressed","=","0"],["computer_hardware.status","=","1"],["computer_os_type","!=","MACOS"],["computer_os_type","!=","AIX"]]}&columns[]=instance_id&columns[]=computer_bigfix_id&columns[]=component_name&columns[]=component_release&columns[]=component_detailed_version&columns[]=component_publisher_name&columns[]=is_present&columns[]=discovery_start&columns[]=discovery_end&columns[]=discovery_path&columns[]=computer_id&columns[]=computer_name&columns[]=is_suppressed&columns[]=usage_data.has_usage&columns[]=usage_data.last_used&columns[]=usage_data.total_runs&columns[]=computer_hardware.status&columns[]=computer_hardware.server_model&columns[]=computer_os&columns[]=computer_os_type&columns[]=product_name&columns[]=product_publisher_name&columns[]=product_release_name&columns[]=product_release&columns[]=computer_details.last_seen
Note: The actual URL will be slightly different as it will be URI encoded and it will follow ServiceNow formatting. You can review logs of API calls with their URLs in BigFix Inventory’s tema.log.
Example of API JSON response:
{
  "total": 25644,
  "rows": [
    {
      "id": 3,
      "bigfix_id": 10000000,
      "computer_group_id": 0,
      "name": "BFI-T-WIN19",
      "dns_name": "BFI-t-Win19",
      "os": "Win2019 10.0.17763.107 (1809)",
      "os_type": "WINDOWS",
      "first_seen": "2024-10-31T16:05:05Z",
      "last_seen": "2025-01-25T00:10:53Z",
      "is_deleted": 0,
      "deletion_date": null,
      "is_managed_by_vm_manager": 1,
      "computer_hardware": {
        "status": "1",
        "server_serial_number": "XXXXXXXXXXXXXXXX",
        "computer_type": 1,
        "server_type": null,
        "server_model": "PowerEdge M640",
        "server_vendor": "Dell Inc."
      },
      "detailed_hw_smbios": [
        {
          "system_serial_number": "VMware-XX XX XX XX XX XX XX XX-XX XX XX XX XX XX XX XX"
        }
      ],
      "detailed_hw_ip_addresses": [
        {
          "permanent_mac_address": "00:00:00:00:00:00",
          "id": 3,
          "address": "10.100.100.100",
          "ipv6_address": "0000:0000:0000:0000:0000:0000:00000000"
        }
      ],
      "detailed_hw_storages": [
        {
          "total_size": "102398",
          "id": 5,
          "device": "\\\\.\\PHYSICALDRIVE0"
        },
        {
          "total_size": "0",
          "id": 6,
          "device": ""
        }
      ],
      "detailed_hw_memories": [
        {
          "total_physical": "8388084",
          "id": 3
        }
      ],
      "detailed_hw_network_adapters": [
        {
          "type": "Ethernet Adapter",
          "permanent_address": "00:00:00:00:00:00",
          "current_address": "00:00:00:00:00:00",
          "model": "Intel(R) 82574L Gigabit Network Connection"
        }
API data availability in BigFix Inventory report columns
BigFix Inventory Computers API BigFix Inventory U
instance_id (not available)
computer_bigfix_id Data Source Computer ID
component_name Component Name
component_release Component Version
component_detailed_version Component Detailed Version
component_publisher_name Publisher Name
is_present Present
discovery_start Discovery Start
discovery_end Discovery End
discovery_path Installation Path
computer_id Internal Computer ID
computer_name Computer Name
is_suppressed Suppressed
computer_os Operating System
computer_os_type (not available)
product_name Product Name
product_publisher_name Product Publisher Name
product_release_name Product Name
product_release Product Version
computer_hardware.status Status
computer_hardware.server_model Server Serial Number
usage_data.has_usage Has Usage
usage_data.last_used Last Used
usage_data.total_runs Total Runs
computer_details.last_seen Computer Last Seen

Software Packages (cmdb_ci_spkg)

CMDB field name API field name ETL transforme
Discovery source (value hard coded to SG-BigFix)
First discovered discovery_start
Key component_name, component_release ✓
Manufacturer component_name, component_release, component_publisher_name ✓
Name component_name, component_release, component_publisher_name ✓
Version component_name, component_release, component_publisher_name ✓

Software Instances (cmdb_software_instance)

CMDB field name API field name ETL transforme
Name component_name, component_release, component_publisher_name, computer_name ✓
Installed on (internal computer reference)
Install date discovery_start ✓
Software installation (cmdb_sam_sw_install)
CMDB field name API field name ETL transforme
Configuration Item (not available)
Mac Address detailed_hw_network_adapters.permanent_address
Discovery source (value hard coded to SG-BigFix)
Display name component_name, component_release, component_publisher_name ✓
Publisher component_name, component_release, component_publisher_name ✓
Version component_name, component_release, component_publisher_name ✓
Installed on installed_on