Inclusion of instances in a pricing calculation

You use the POST operation on the api/sam/swinventory/include element to include instances in the pricing calculation.

An icon representing a user. You must have the Manage Software Classification permission to perform this task.
Important: Use this REST API only for BigFix products. The REST API returns only instances that are assigned to default license metrics.
Table 1. Operation descriptions
Operation details Description
Operation /api/sam/swinventory/include
Purpose Includes instances in a pricing calculation.
HTTP method POST
Resource URI https://server_host_name:port_number/api/sam/swinventory/include
URL link relation n/a
URI query parameters For a list of applicable query parameters, see: Query parameters.
Request headers
Accept-Language (optional)
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 n/a
Response headers
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 n/a
Response Content-Type n/a
Normal HTTP response codes
  • 204 – No content
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 the user requested does not exist
  • 422 – “Unprocessable Entity” if the request was well-formed but was unable to be followed due to semantic errors

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 POST/swinventory/include element.
Table 2. Query parameters for including instances in pricing calculations

The table consists of four columns and three rows.

Parameter Description Required Value
productInventoryId A list of unique identifiers of instances that are to be included in the calculation separated with a comma. At least one identifier must be specified. Yes Numeric
token A unique user authentication identifier. Yes Alphanumeric
updateTime A list of timestamps of the last modification time of instances expressed in milliseconds. The timestamps are separated with a comma. The first timestamp in the list corresponds to the first instance, and so on. This parameter is used to handle concurrent actions.

Use the GET operation on the swinventory/release/{release_id}/instances element to get the update times.

Yes Numeric

Example HTTP conversation

POST /api/sam/swinventory/include?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
&productInventoryId=198,300201&updateTime=1349237658578,1349237658588 HTTP/1.1
Host: localhost:9080
Accept-Language: en-US
Response header
HTTP/1.1 204 OK
Content-Type: application/json
Content-Language: en-US