REST API associations

Available from 9.2.8. For REST APIs in version 2, you can use associations to retrieve additional data as part of API requests. For example, you can retrieve detailed information about computer hardware as part of the software_instances API request.

Syntax

To retrieve the additional data, use the following syntax of the query:
<URL>?columns[]=<association>.<column>&token=<token>
Where:
  • <URL> is the REST API request
  • <association> is the name of the association from which you want to retrieve the column
  • <column> is the name of the column that you want to retrieve
  • <token> is the unique user authentication identifier
For example:
GET api/sam/v2/software_instances?columns[]=computer_health.catalog_version
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Note: Use API associations to retrieve information that cannot be obtained directly through an existing API.