Deprecated: Retrieval of software products

Edit online

You use the GET operation on the api/sam/swinventory/products element to request information about the software products that are installed in your infrastructure. This REST API returns only instances that are assigned to default license metrics.

Important: This REST API is deprecated. To retrieve similar data, use REST API for retrieving software inventory and metric utilization and classifying software (v2).

Permissions

An icon representing a user. You must have the Manage Software Classification permission to perform this task.

Resource URL

https://hostname:port/api/sam/swinventory/products

Resource information

Table 1. Resource information
Operation details Description
Purpose Returns a list of software products.
HTTP method GET
Resource URI https://hostname:port/api/sam/swinventory/products
URI query parameters For a list of applicable query parameters, see: Query parameters.
Request headers
Accept-Language (optional)
  • Use: Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.
  • Values: en-US (only English is supported)
Token
  • Use: Used to authenticate REST API requests. The header is required when you set the value of the api_token_in_url_enabled parameter to false. Otherwise, you can specify the token in the request header or in the URL. For more information, see: Authenticating REST API requests.
  • Values: an alphanumeric string that is generated in License Metric Tool
Request payload n/a
Request Content-Type
  • Application/json
Response headers
Content-Type
  • Use: Specifies the content type of the response.
  • Values: application/json
Content-Language
  • Use: Specifies the language of the response content. If this header is not specified, the content is returned in the server language.
  • Values: en-US, …
Response payload Products element
Response Content-Type
  • Application/json
Normal HTTP response codes
  • 200 – OK
Error HTTP response codes
  • 400 – “Bad Request” if a query parameter contains errors or is missing
  • 401 – “Unauthorized” if the user is not authorized to perform the operation
  • 416 – “Requested Range Not Satisfiable” if the user provided a start or count range that cannot be satisfied

Message body includes an error message with details.

Available columns

Table 2. Available columns
Column Description Displayed by default Type
nmbOfAllRows Number of products that are returned by the REST API request. ✓ Integer
licenseType Indicates the type of the license that is assigned to the product. Possible values are:
  • 1 - Other
  • 5 - PVU
  • 6 - RVU MAPC
Tip: To retrieve more detailed information about the type of the license, use the api/sam/v2/software_instances REST API.
 ✓ Integer
level Indicates whether the discovered software is a component or a product. In this REST API, the returned value is always product. ✓ String
children Indicates whether any instances of this product release are discovered. ✓ Boolean
confidence Confidence of the default assignment of a software component to the software product that is expressed in per cents. ✓ Integer
productReleaseComponent Name of the software product. ✓ String
isConfirmed Indicates whether the software classification was manually confirmed. Possible values are:
  • 0 - Not confirmed
  • 1 - Confirmed
 ✓ Integer
id Identifier of the software product. ✓ Integer
type For internal use only. In this REST API, the returned value is always root. ✓ String

Query parameters

You can use query parameters to narrow down the results of your search. The following table presents query parameters that you can use for the swinventory/products element.
Table 3. Query parameters for retrieving software products
Parameter Description Required Value
confirmed_filter The state of bundling confirmation. If the parameter is not specified, both confirmed and unconfirmed software instances are displayed. No true
false
count The number of rows to be returned. No Numeric
Default: 80
endDate Discovery end date. If the parameter is not specified, the current date is used. No Date in the YYYY-MM-DD format
part_number_filter The part number to which the software item was assigned according to the imported part number list. No String
product_release_
component_filter 		The name of the software product, release, or component. No String
start The number of the first row of data to be returned. No Numeric
Default: 0
startDate Discovery start date. If the parameter is not specified, the start date is set either to 90 days back, or to the server installation date, depending on which one of these dates is closer to the current date. No Date in the YYYY-MM-DD format

Example HTTP conversation

Request
GET https://hostname:port/api/sam/swinventory/products
?startDate=2012-10-19&endDate=2012-10-19
Request header
Accept: application/json 
Accept-Language: en-US
Token: <token>
Response header
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
Response body (JSON)
[{
"nmbOfAllRows" : "1967",
"licenseType" : "1",
"level" : "product",
"children" : "true",
"confidence" : "99",
"productReleaseComponent" : "AIX 5.2 Workload Partitions for AIX 7",
"isConfirmed" : "false",
"id" : "30369",
"type" : "root"