Retrieving software product data using the REST API

Software product data can be retrieved using the software resource. It allows you to:

• retrieve all software product data (full software product catalog)
• retrieve software product data for all products of a particular vendor
• retrieve software product data for all product versions of a particular product
• retrieve software product data for a particular version of a software product
• use filters to narrow down the output in respect to software category and product lifecycle stage.

The GET method is used for all operations mentioned above. The resulting content conforms to the Portable Inventory Data format.

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