Setting the end of support date for software components

9.2.11 Available from 9.2.11. You use the POST operation on the sam/component_lifecycles element to set the end of support date for software components. The end of support date is added on the Software Components report. If you want to change the end of support date, you must first delete the current date and then set a new one by using this API.

Permissions

User You must have the Manage Catalogs permission to use this API.

Resource URL

https://hostname:port/sam/component_lifecycles?token=token
Note: The URL is going to change in the future. If you are going to use it for integration, check for updates in future releases.

Resource information

Table 1. Resource information
Operation details Description
HTTP method POST
Request headers
Header
Accept-Language (optional)
Values
en-US (only English is supported)

Negotiates the language of the response. If the header is not specified, the content is returned in the server language.
Header
Content-Type
Values
application/json

Specifies the content type of the request.
Request format application/json
Request payload { "component_lifecycle": { "eos_date": "YYYY-MM-DD", "software_component_id": "software_component_id"} }
Response headers
Header
Content-Type
Values
application/json

Specifies the content type of the response.
Header
Content-Language
Values
en-US, …

Specifies the language of the response content. If the header is not specified, the content is returned in the server language.
Response format application/json
Response codes

200 – OK

422 – "Unprocessable entity" if a parameter contains errors or is missing

Example conversation - setting end of support date for a software component

  1. To retrieve information about the software component ID for which you want to set the end of support date, perform the following steps:
    1. Log in to BigFix Inventory.
    2. Go to Reports > Software Components.
    3. Hover over the component name and check the URL address at the bottom of the page. The software component ID is a number at the end of the URL. For example: sam/catalog/software_components/10379
  2. To set the end of support date, use the following POST request.
    Request header
    POST sam/component_lifecycles?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
    Request Body
    { "component_lifecycle": 
{ 
"eos_date": "2020-12-22", 
"software_component_id": "10379"}
 }
    Response Header
    200 - OK
    Response Body
    {
  "created_at": "2018-01-26T10:30:06Z",
  "detailed_version": null,
  "eos_date": "2020-12-23",
  "id": 2,
  "is_release": true,
  "software_component_id": 10379,
  "source_id": 1,
  "source_type": 0,
  "updated_at": "2018-01-26T10:30:06Z"
}