Retrieving software product data using the REST API

The software product data resource allows you to easily access and manage all of your software products in one convenient location. With the software resource, you have the ability to retrieve the entire software product catalog, all products from a specific vendor, all versions of a specific product, and even information on a specific version of a software product. Additionally, you can use filters to narrow down your output based on software category and product lifecycle stage. All operations in this section of the API utilize the GET method, and the resulting content is formatted according to the Portable Inventory Data format for easy integration with other systems.

Retrieving the full software catalog

GET ot-base/api/v1/software

Retrieves all software products in the software product catalog.

Retrieving software products of a particular vendor

GET ot-base/api/v1/software/?vendor=vendorName

Retrieves all software products of a particular vendor. The vendor name might need to be quoted if it contains special characters.

Wildcard search is supported by using the special character %. For example, the following search

GET ot-base/api/v1/software/?vendor=micro%

will return results both for the vendor name Microsoft and for Microsoft Corporation.

Retrieving particular software products, identified by product name

GET ot-base/api/v1/software/?vendor=vendorName&name=productName

Retrieves all versions of a software product of a particular vendor. The vendor and product names might need to be quoted if they contain special characters.

The name filter can only be used in conjunction with the vendor filter.

Retrieving particular software product versions

GET ot-base/api/v1/software/?vendor=vendorName&name=productName&version=versionNumber

Retrieves product data for a particular software product version. The vendor name, product name, and version number might need to be quoted if they contain special characters.

The version filter can only be used in conjunction with the vendor and name filter.

Retrieving software products of a particular software category

Filtering by software category can be done by using the category filter. For example, the following query will output only operating systems:

GET ot-base/api/v1/software/?category=os

Category filters can be combined in order to search for multiple categories in one query. As an example, the following query retrieves both operating systems and security patches:

GET ot-base/api/v1/software/?category=os,patch

Retrieving software products installed at a particular location

You can limit the result set to products installed at a particular location by providing the location ID of that location using the parameter locationid. Example:

GET ot-base/api/v1/software/?locationid=usa

Retrieving software products in a particular product lifecycle stage

Filtering by product lifecycle stage is accomplished by using the lifecycle filter. It can take the values active, phaseout, end of support, and discontinued.

In the following example, we search for all Siemens software products for which support has ended:

GET ot-base/api/v1/software/?vendor=siemens&lifecycle=end%20of%20support