Retrieval of instances shared by releases

You use the GET operation on the api/sam/swinventory/instanceToShare element to request information about the releases that can share a particular instance.

An icon representing a user. 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
Operation details Description
Operation GET /api/sam/swinventory/instanceToShare
Purpose Returns a list of software releases that can share a particular instance.
HTTP method GET
Resource URI https://server_host_name:port_number/api/sam/swinventory/instanceToShare
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.
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 targetReleases element
Response Content-Type
  • Application/json
Normal HTTP response codes 200 – OK
Error HTTP response codes
  • 400 – “Bad Request” if a parameter contains errors or is missing
  • 401 – “Unauthorized” if you are not authorized for the operation
  • 404 – “Not Found” if a release or instance of the product or version that is requested does not exist

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/instanceToShare element.
Table 2. Query parameters for retrieving an instance shared by releases
Parameter Description Required Value
productInventoryId A unique identifier of a product. Yes Numeric
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/instanceToShare
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623&productInventoryId=200032 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)
[{
	"productId": "64050",
	"isSelected": "true",
	"productInventoryId": "200032",
	"appliedRules": "the relation in the software catalog, the stand-alone product discovery",
	"productName": "IBM Alphablox for Linux, UNIX and Windows 9.5",
	"id": "64050",
	"branchType": "0",
	"isShared": "false"
}
]