Retrieval of instances to reassign to a release

You use the GET operation on the api/sam/swinventory/targetInstances element to request information about the target instances that can be reassigned to a particular release.

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/targetInstances`
Purpose	Returns a list of target instances that can be reassigned to a particular release.
HTTP method	`GET`
Resource URI	https://`server_host_name`:`port_number`/api/sam/swinventory/targetInstances
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	`targetInstances` 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 a user is not authorized to perform the operation `404 – “Not Found”` if a release or instance of the product or version that you requested for 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 GET/swinventory/targetInstances element.

Table 2. Query parameters for retrieving instances to reassign to a release
Parameter	Description	Required	Value
releaseId	A unique identifier of a release.	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/targetInstances
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623&releaseId=72717 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)

[{
	"componentNameVersion": "IBM Tivoli Directory Server (SP) 6.0",
	"hostname": "Agent20",
	"path": "C:\Documents and Settings\Administrator\Signatures",
	"updateTime": "1349270690593",
	"productInventoryId": "200027",
	"appliedRules": "the relation in the software catalog, the infrastructure co-location",
	"productId": "72717",
	"id": "200027",
	"productNameVersion": "IBM WebSphere Process Server Hypervisor Edition for Novell SLES for x86 6.2",
	"isShared": "false"
}]