Retrieval of software products

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.

You must have the Manage Software Classification permission to perform this task.

Important: Use this REST API only for IBM products. This REST API returns only instances that are assigned to default license metrics.

Table 1. Operation descriptions
The table consists of two columns and 15 rows. For the eleventh row there are two levels.
Operation details	Description
Operation	`GET /api/sam/swinventory/products`
Purpose	Returns a list of software products.
HTTP method	`GET`
Resource URI	https://`server_host_name`:`port_number`/api/sam/swinventory/products
URL link relation	n/a
URI query parameters	For a list of applicable query parameters, see: Query parameters.
Request headers	Header `Accept-Language` (optional) Values en-US (only English is supported) Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.
Request payload	n/a
Request `Content-Type`	`Application/json`
Response headers	Header `Content-Type` Values `Application/json` Specifies the content type of the response.
Response headers	Header `Content-Language` Values en-US Specifies the language of the response content. If this header is not specified, the content is returned in the server language.
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
The table consists of four columns and 9 rows.
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
The table consists of four columns and nine rows.
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	truefalse
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
token	A unique user authentication identifier. Note: The token includes information about the computer group to which the user has access. Data that is retrieved is limited to data from computers that belong to this group.	Yes	Alphanumeric

Example HTTP conversation

Request

GET /api/sam/swinventory/products
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623&startDate=2012-10-19
&endDate=2012-10-19 HTTP/1.1
Host: localhost:9080 
Accept: application/json 
Accept-Language: en-US

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"