Share an instance with more than one product

You use the POST operation on the api/sam/swinventory/share element to share an instance of a component with more than one product.

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/share
Purpose Shares an instance with a list of software products.
HTTP method POST
Resource URI https://server_host_name:port_number/api/sam/swinventory/share
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 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 use for the POST/swinventory/share element.
Table 2. Query parameters for sharing an instance with more than one product

The table consists of four columns and four rows.
Parameter Description Required Value
productIds

A list of unique product identifiers separated with a comma. At least one identifier must be specified.

Use the GET operation on the swinventory/instanceToShare element to get product identifiers.

 Yes Numeric
productInventoryId A unique identifier of an instance that is shared by products. Yes Numeric
token A unique user authentication identifier. Yes Alphanumeric
updateTime

Timestamp of the last modification time of the instance expressed in milliseconds. This parameter is used to handle concurrent actions.

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

 Yes Numeric

Example HTTP conversation

Request
POST /api/sam/swinventory/share?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
&productInventoryId=200032&updateTime=1349237658578&productIds=70665,70656 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