Exclusion of instances from pricing calculations

You use the POST operation on the api/sam/swinventory/exclude element to exclude instances from pricing calculations.

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/exclude
Purpose Excludes instances from a pricing calculation.
HTTP method POST
Resource URI https://server_host_name:port_number/api/sam/swinventory/exclude
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 n/a
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 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 excludes 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/exclude element.
Table 2. Query parameters for excluding instances from pricing calculations
Parameter Description Required Value
productInventoryId A list of unique identifiers of instances to be excluded from the calculation separated with a comma. At least one identifier must be specified. Yes Numeric
reason The reason for excluding an instance from the pricing calculations. Yes backupbetacomponentevaluationno_licensingnot_compatibleother
comment Additional comments for the reason of exclusion. Only when reason is other String
token A unique user authentication identifier. Yes Alphanumeric
updateTime A list of timestamps of the last modification time of the instances expressed in milliseconds. Each timestamp is 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

Request
POST /api/sam/swinventory/exclude
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
&productInventoryId=300001,500001&updateTime=1349237658578,1349237658588
&reason=no_licensing 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