Retrieval of release instances
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: Use this REST API only for
IBM products. This REST API returns only instances that are assigned to default license
metrics.
Operation details | Description |
---|---|
Operation | GET /api/sam/swinventory/release/{release_id}/instances |
Purpose | Returns a list of instances for the requested software product release. |
HTTP method | GET |
Resource URI | https://server_host_name:port_number/api/sam/swinventory/release/{release_id}/instances |
URL link relation | n/a |
URI query parameters | For a list of applicable query parameters, see: Query parameters. |
Request headers |
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 |
|
Response headers |
Specifies the content type of the response. |
Specifies the language of the response content. If this header is not specified, the content is returned in the server language. |
|
Response payload | Instances element. Each instance
is a single component on a single agent. |
Response Content-Type |
|
Normal HTTP response codes |
|
Error HTTP response codes |
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.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 |
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 |
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/release/61922/instances ?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)
[{ "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": "NC042189", "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" }]