View Deployed Applications on All Devices with REST API (Installed Software) (version 1.0)

Use INSTALLED_SOFTWARE to check the software present on each Windows physical monitored device, along with its version and deployment date. It includes all software deployed on the device but does NOT include Universal Windows Platform (UWP) applications (learn more)..

For example, you can check the devices which are not running the newest version of Lenovo drivers, which may impact reliability, or those which do not run the latest Windows patches, which can have security implications.

Tip

You can use this API to save significant licensing costs by checking the devices which have an app versus those which actually use that app. If they do not use, why are you paying for its license on that device? Learn more.

Each entry from INSTALLED_SOFTWARE returns information for a single piece of software present on a single device.

Note

You can access data using this API (retention) going back up to 90 days, that is all devices which reported to Aternity during that time.

Before You Begin

To send a REST API query in Excel, PowerBI or a browser, enter the URL of the REST API, your Aternity username (must have the OData REST API role) and its password. You can find this by selecting User icon > REST API Access. SSO users must generate (once) and use a special password, as Aternity's REST API does not authenticate with your enterprise's identity provider.

To view an Aternity REST API, enter the base URL from User icon > REST API Access, followed by the name of the API: <base_url>/API_NAME into a browser, Excel or PowerBI (learn more). :

Tip

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.

Examples

To access this API from a browser, Excel or Power BI (learn more), enter <base_url>/INSTALLED_SOFTWARE

To see all the devices with a specific OS update, such as Security Update KB2966828, enter ...INSTALLED_SOFTWARE?$filter=INSTALLED_SW_NAME eq 'Security Update KB2966828'

To return a list of all of the Lenovo drivers for each device, use: .../INSTALLED_SOFTWARE?$filter=INSTALLED_SW_VENDOR eq 'Lenovo Group Limited'&$Select=DEVICE_NAME,INSTALLED_SW_NAME

Supported Parameters

You can view the data by entering the URL into Excel, into a browser, or into or any OData compatible application such as Power BI.

You can add parameters to the URL to filter the returned data, by adding a question mark (?) followed by a parameter and value, such as .../API_NAME?$filter=(USERNAME eq 'jsmith@company.com'), or several parameter-value pairs each separated by an ampersand (&), like .../API_NAME?$format=xml&$top=5.

Parameter Description
$select=

Use $select to return only specific columns (attributes), to make queries more efficient: ...API_NAME?$select=COL1,COL2,COL3

$filter=

Use $filter to insert conditions that narrow down the data, to return only entries where those conditions are true..

Create conditions with operators: and, or, eq (equals) gt (greater than), ge (greater than or equal), lt (less than), le (less than or equal), ge (greater than or equal to), ne (not equal to), le (less than or equal to), not and contains. Use operators with parentheses to group conditions logically: .../API_NAME?$filter=(COLUMN1 eq 'value1' or COL2 neq 'val2') and (COL3 gt number) and not (COL4 eq 'val4' or contains(COL5,'val5'))

$format=

Use $format to force the returned data to be either in XML or JSON format. This is only useful for testing the raw data in a web browser. For example: .../API_NAME?$format=xml

$orderby=

Use $orderby to sort the returned data according to the value you choose. For example, .../API_NAME?$orderby=LOCATION

$top=

Use $top (lower case only) when you are initially testing the response of the API by returning the first few entries.

For example, to return the first five entries (not sorted), use: ...API_NAME?$top=5

$search is NOT supported.

Do not use $search in Aternity's REST APIs.

Tip

Wherever possible, use $select and $filter to narrow your query, to avoid receiving an error like Returned data is too large. Learn more.

Output

Each entry from INSTALLED_SOFTWARE returns information for a single piece of software present on a single device.

You can access data using this API (retention) going back up to 90 days, that is all devices which reported to Aternity during that time.

The API returns two types of columns: Attributes (or dimensions) which are the properties of an entry, and Measurements which are the dynamic measured values. A single API row can display either a single measurement, or a weighted average of several entries grouped together. If you use $select to display several attributes, and all those attributes are identical, it groups them into a single entry.

Type Returned columns

Measurements

Installed_Sw_Last_Change_Time,Volume

Attributes

Account_ID,Account_Name,Device_Count,Device_Name,Installed_Sw_Count,Installed_Sw_Last_Change_Time,Installed_Sw_Name,Installed_Sw_Related_To,Installed_Sw_Scope,Installed_Sw_Type,Installed_Sw_Vendor,Installed_Sw_Version,Installed_Sw_Version_Count