Advanced Software Configuration

Include information about the software that is installed on devices.

Before you start

In the Integration Details section, select the checkbox in the Enable Extra Details subsection. Go to the Advanced Software Configuration section and click Edit .  

Format of the additional API request

Web Service URL field

If an additional API request is required to return software information, review the following information.

Let's say the initial Web service URL that you entered in the Integration Details section returns a list of assets, and the software information is nested in an object.

The initial Web service URL is: https://api.cosc.com/generic_assets_list? And, the unique identifier for each item returned is barcode.  

The format of the URL is

 https://<web_service_url>unique_asset_id={{list_response_item.unique_asset_id}}

In this case, the Web service URL that you enter is

https://api.cosc.com/generic_assets_list?barcode={{list_response_item.barcode}}

Result field

Enter code to specify the object or list that contains the software information:

• You have added an API call to return the software information. You want to return the software items nested in the applications object: {{software_response['applications']}}.
• You have not added an API call to return the software information. And, the software information is contained in a list called applications, you enter: {{detail_response['applications']}}.  

Procedure

1. If an additional API call is required to return the software information, switch the toggle on .  
2. Enter the Web service URL.
3. Ensure the method is GET.
4. Optional. Add headers and parameters.
5. In the Result field, enter code to extract the software information from the response.
6. In the Software Name Key field, enter code to extract the names of the software. For example,   {{software_response_item['name']}} - name is the name of the field returned in the API response.
7. In the Software Version Key field, enter code to extract the versions of the software. Enter  {{software_response_item['version']}}- version is the name of the field returned in the API response.
8. Save your changes.

Review the response for the software API call

When you complete and save the configuration, go to the Response section, click Review response , and select SOFTWARE RESPONSE.  A list of the fields and their values that are retrieved by the API call for the first few records are displayed and a list of the fields and values that can be mapped to Oomnitza are displayed.