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.
Software Products and Software Components
BigFix Inventory detects software components which are bundled with the product.

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.
  - 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.

Software Products and Software Components

BigFix Inventory detects software components which are bundled with the product.

The list shows the available software component. You can add a software component to Inventory as required. Below given is an example to BigFix Platform Agent which is installed at /opt/BESClient/bin/.

Use the Software Component listing to see the number of active and inactive components. Each row shows details, such as usage, product and metric that it is added to, the installation path about the selected component. You can select multiple components.

You can access information about computer properties through Computer Properties (Management > Computers). You can access the computer properties through the user interface or the API.

Note: The API shows the computer properties by its number and ID and not by its name.

Table 1. API
computer_property_number	Custom computer property that was added on the Computer Properties panel. To view the list of all custom properties, view the `computer_details` schema. The name of the property as displayed on the user interface is shown in the `title` parameter.

You can use this feature to access user information, such as username from the system. It provides the basic user information which is already available at the Platform level. The user information may vary for each application.