Deprecated: Retrieval of instances to reassign to a release

Edit online

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.

Important: This REST API is deprecated. Use: Retrieval of bundling options (v2). To learn how the new flow of reassigning software using REST API looks like, see: Tutorial: Software classification using REST API.

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/targetInstances

Resource information

Table 1. Resource information
Operation details Description
Purpose Returns a list of target instances that can be reassigned to a particular release.
HTTP method GET
Resource URI https://hostname:port/api/sam/swinventory/targetInstances
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 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

Example HTTP conversation

Request
GET https://hostname:port/api/sam/swinventory/targetInstances
?releaseId=72717
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)
[{
	"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"
}]