Home
Integrating with REST API
External systems integration is one of the key features of BigFix Inventory. Business logic is enabled for integration and interfaces are provided for common integration points.
REST API
Managing large amounts of information by using the application user interface can be time-consuming. You can use the REST APIs as an alternative to the graphical user interface to reduce the time that is needed to manage your software inventory and the content of your software catalog.
Mapping REST API versions
Available from 9.2.8. For some REST APIs, version 2 is created to provide improved functions or experience. In such cases, the original API becomes deprecated with time and only version 2 is further developed. If you have custom tools or internal processes that are based on such REST APIs, it is best to adjust the tools to use the new version of the APIs.
Mapping columns between computer_systems and v2/computers REST API
Available from 9.2.8. If you have custom tools or internal processes that use the computer_systems REST API, learn how columns in this API map to the columns in the v2/computers API. It is best to adjust the tools to use REST API in version 2.

Integrating with REST API
External systems integration is one of the key features of BigFix Inventory. Business logic is enabled for integration and interfaces are provided for common integration points.
- REST API
  Managing large amounts of information by using the application user interface can be time-consuming. You can use the REST APIs as an alternative to the graphical user interface to reduce the time that is needed to manage your software inventory and the content of your software catalog.
  - Software Products and Software Components
    BigFix Inventory detects software components which are bundled with the product.
  - REST API resources and HTTP methods
    The operations of the BigFix Inventory REST API protocol are defined as HTTP methods on certain REST resources.
  - Common REST API elements
    You use connectors and operators to build query segments that filter on matching conditions and values.
  - Mapping REST API versions
    Available from 9.2.8. For some REST APIs, version 2 is created to provide improved functions or experience. In such cases, the original API becomes deprecated with time and only version 2 is further developed. If you have custom tools or internal processes that are based on such REST APIs, it is best to adjust the tools to use the new version of the APIs.
    - Mapping columns between software_instances and v2/software_instances REST API
      Available from 9.2.8. If you have custom tools or internal processes that use the software_instances REST API, learn how columns in this API map to the columns in the v2/software_instances API. It is best to adjust the tools to use REST API in version 2.
    - Mapping columns between computer_systems and v2/computers REST API
      Available from 9.2.8. If you have custom tools or internal processes that use the computer_systems REST API, learn how columns in this API map to the columns in the v2/computers API. It is best to adjust the tools to use REST API in version 2.
    - Mapping functions of the software_instances REST API
      Available from 9.2.14. If you have custom tools or internal processes that use the software_instances REST API, learn how to achieve your goals by using the v2/license_usage and v2/software_instances REST API. It is best to adjust the tools to use REST API in version 2.
  - REST API for retrieving authentication token
    You use the POST operation on the api/get_token element to request your unique token that is required to authenticate the REST API requests.
  - REST API for retrieving the BigFix Inventory version
    You use the GET operation on the api/sam/about element to request information about the version of BigFix Inventory.
  - Core APIs
    Core APIs include all primary set of APIs that are integrated with BigFix Inventory.
  - Configuration APIs
    Configuration APIs include all APIs that you need to configure the application.
  - Historical APIs
    For some REST APIs, version 2 is created to provide improved functions or experience. In such cases, the original API is deprecated and version 2 is supported. You must adjust your custom tools or internal processes to the new version of these APIs.

Mapping columns between computer_systems and v2/computers REST API

Available from 9.2.8. If you have custom tools or internal processes that use the computer_systems REST API, learn how columns in this API map to the columns in the v2/computers API. It is best to adjust the tools to use REST API in version 2.

Note: If a column from the computer_systems API that you use does not map to any column in the v2/computers API or the mapping provides insufficient granularity of information, submit an idea.

Table 1. Mapping computer_systems to v2/computers REST API
computer_systems API	computers API	Comments
id		Computer systems are substituted with computers.
parent_id		Computer systems are substituted with computers. Additionally, REST API version 2 is not hierarchical.
computer_id	id
computer_remote_id	bigfix_id
server_id	computer_hardware.server_id
datasource_name
datasource_id
type	computer_hardware.computer_type	REST API version 2 has three possible values: physical, virtual, and computer running on a public cloud.
os	os
host_name	name
dns_name	dns_name
ip_address	ip_address
last_seen	last_seen
hardware_manufacturer		The information is contained in the computer_hardware.server_name column.
hardware_model		The information is contained in the computer_hardware.server_name column.
hardware_serial_number		The information is contained in the computer_hardware.server_name column.
hardware_type		The information is contained in the computer_hardware.server_name column.
hardware_name	computer_hardware.server_name
processor_brand_string	computer_hardware.processor_brand_string
processor_type	computer_hardware.processor_type
processor_brand	computer_hardware.processor_brand
processor_vendor	computer_hardware.processor_vendor
partition_cores	computer_hardware.partition_cores
server_processors	computer_hardware.node_total_processors
server_cores	computer_hardware.server_cores
pvu_per_core	computer_hardware.pvu_per_core
uuid
cluster_id		Cluster ID is substituted with cluster name that is available in the computer_hardware.cluster_name column.