Classifying software (v2)
Available from 9.2.14. You can use the PUT
operation on the api/sam/v2/software_instances
element to define, change, or
migrate software classification.
Permissions
You must have the View Endpoints and View Hardware Inventory permissions to use this API.
Resource URL
https://hostname:port/api/sam/v2/software_instances?token=token
Resource information
Operation details | Description |
---|---|
HTTP method | PUT |
Request headers |
Negotiates the language of the response. If the header is not specified, the content is returned in the server language. |
Request format | application/json |
Response headers |
Specifies the content type of the response. |
Specifies the language of the response content. If the header is not specified, the content is returned in the server language. |
|
Response payload | n/a element |
Response format | application/json |
Response codes |
|
Parameters
- token
- is_charged
- metric_id
- product_release_guid
- instance_id, or, alternatively, a combination of parameters including: a parameter that identifies a computer: computer_dns_name or computer_bigfix_id and a parameter that identifies software: discoverable_guid that can be followed by the discovery_path parameter for precision.
Parameter | Description | Type |
---|---|---|
instance_id | Identifier of the component instance. | Numeric |
computer_bigfix_id | Identifier of the computer as defined in BigFix. | Numeric |
computer_dns_name | DNS of the computer. | String |
discoverable_guid | Component GUID. | String |
discovery_path | Path under which the component is installed. Available for BigFix products
only. For non-BigFix products, the returned value is null . |
String |
product_release_guid | Product release GUID. | String |
metric_id | Identifier of the license metric that is used by the product. For information about the
meaning of each metric_id , see: Metric IDs and code names. |
String |
is_confirmed | Information whether the assignment of the component to the product is confirmed. | Boolean |
is_excluded | Information whether the product is excluded from pricing calculations. | Boolean |
is_suppressed | Information whether the component is suppressed on the computer on which it is installed. | Boolean |
exclusion_or_suppress_comment | Comment that was provided during the exclusion or suppression. | String |
is_charged | Information whether the component to product assignment is charged. | Boolean |
token | A unique user authentication identifier. You can retrieve it by using REST API for retrieving authentication token. You can also log in to BigFix Inventory, hover over the User icon , and click Profile. Then, click Show token. | Alphanumeric |
verbose | Descriptive information about the result of an API request. By default, this parameter is set to false. | Boolean |
simulate | By adding this parameter to API request you can test the call to view its results and status. By default, this parameter is set to false. | Boolean |
Example conversation
- Request
-
PUT api/sam/v2/software_instances?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623 Host: localhost:9081 Accept: application/json Accept-Language: en-US
- Response body
-
200 - OK
Example conversation - migrating software assignments between BigFix servers
For more information, see: Tutorial: Migrating software assignments between two BigFix servers.