Deprecated: Retrieval of releases to which a software instance can be reassigned

Edit online

You use the GET operation on the api/sam/swinventory/targetBundlesOfInstances element to request information about the possible releases to which the requested software instance can be reassigned.

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

Resource information

Table 1. Resource information
Operation details	Description
Purpose	Returns a list of possible releases to which the requested software instance can be reassigned.
HTTP method	`GET`
Resource URI	https://`hostname`:`port`/api/sam/swinventory/targetBundlesOfInstances
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, … Specifies the content type of the response.
Response payload	`targetReleases` 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 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 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/targetBundlesOfInstances element.

Table 2. Query parameters for retrieving releases to which a software instance can be reassigned
Parameter	Description	Required	Value
productInventoryId	A list of unique product identifiers separated with a comma.	Yes	Numeric

Example HTTP conversation

Request

GET https://hostname:port/api/sam/swinventory/targetBundlesOfInstances
?productInventoryId=200032

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)

[{
	"productId": "69558",
	"isSelected": "false",
	"productInventoryId": "200032",
	"appliedRules": "the relation in the software catalog,
	the stand-alone product discovery",
	"productName": "IBM Smart Analytics System 2050 Departmental Base Remote Standby Server 1.0",
	"id": "69558",
	"branchType": "0",
	"isShared": "false"
}]