Deprecated: Retrieval of release instances

Edit online

You use the GET operation on the api/samswinventory/release/{release_id}/instances element to request information about the instances of a software product release for a particular release that is installed in your infrastructure.

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

Before you begin

9.2.34 Starting from application update 9.2.34, this REST API is disabled by default. To enable it, change the value of the expose_deprecated_api parameter on the Advanced Server Settings panel to true. For more information, see: Advanced server settings.

Important: Deprecated REST APIs are going to be removed at the end of 2024. After that period, these REST APIs are going to be unsupported. Switch to version 2 of the REST APIs as soon as convenient.

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/release/{release_id}/instances

Resource information

Table 1. Resource information
Operation details Description
Purpose Returns a list of instances for the requested software product release.
HTTP method GET
Resource URI https://hostname:port/api/sam/swinventory/release/{release_id}/instances
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 Instances element. Each instance is a single component on a single agent.
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
  • 404 – “Not Found” if a release or instance of the product or version that is requested does not exist
  • 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.

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/release/{release_id}/instances element.
Table 2. Query parameters for retrieving release instances
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
name_host_filter The name of the computer on which the software item is installed. No String
name_server_filter The name of the server on which the software item is installed. No String
operating_system_filter Operating system of the computer on which the software item is installed. No String
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/release/{release_id}/instances
?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)
[{
	"isCharged": "true",
	"operatingSystem": "Linux Red Hat Enterprise Server 5.4 (2.6.18-164.el5)",
	"isConfirmed": "false",
	"currentServerId": "TLM_VM_VMware-42 3b 3b 73 2a 12 4a c5-e0 56 d1 30 74 6b 53 2a",
	"updateTime": "1374082814268",
	"children": "false",
	"hostname": "<name>",
	"productInventoryId": "347",
	"id": "347",
	"level": "instance",
	"bundleRules": "the relation in the software catalog, the stand-alone product discovery",
	"processorType": "Intel(R) Xeon(R) Multi-core 3400-3699 or 5500-5699",
	"isAgentDeleted": "false",
	"productReleaseComponent": "IBM CICS Transaction Gateway 6.0",
	"pvuPerCore": "70",
	"installationPaths": "/nfs/bak/SLES10.2/usr/catalog_test/linux01/1",
	"nmbOfAllRows": "4",
	"isSimple": "false"
}]