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

Edit online

You use the GET operation on the api/sam/swinventory/targetBundlesOfReleases element to request information about the possible releases to which the instances of the requested software releases 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/targetBundlesOfReleases

Resource information

Table 1. Resource information
Operation details Description
Purpose Returns a list of possible releases to which the instances of the requested software releases can be reassigned.
HTTP method GET
Resource URI https://hostname:port/api/sam/swinventory/targetBundlesOfReleases
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 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/targetBundlesOfReleases element.
Table 2. Query parameters for retrieving releases to which a release instance can be reassigned
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 true
false
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
releases A list of unique release identifiers separated with a comma. Yes Numeric
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

Example HTTP conversation

Request
GET https://hostname:port/api/sam/swinventory/targetBundlesOfReleases
?releases=64050&startDate=2012-09-29&endDate=2012-10-02
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": "72563",
	"isSelected": "false",
	"productInventoryId": "200223",
	"appliedRules": "the relation in the software catalog",
	"productName": "IBM Database Enterprise Developer Edition 10.1",
	"id": "72563",
	"branchType": "0",
	"isShared": "false"
}]