Use Case 2: Retrieve Data from ADT

After an ADT view is added to TAF Lite, any cell data can be retrieved and returned to the 3^rd-part system via API call.

API Parameters

To locate and retrieve data from a specific cell, the API is required to include a column name and a rule to filter out row names.

Tip: If no rule is defined to filter out the rows, data from all rows in the column will be returned to the 3rd-party system.

• API URL: API/V3/TAF/Lite/adt/data
• Description: The API is for retrieving ADT data.
• Input Parameters:
  

  Parameter	Type	Required	Description
  endpoint	string	Yes	The endpoint generated by the system when users add an ADT view to TAF Lite.
  passKey	string	Yes	To authenticate the access to the ADT view.
  filterDevices	array	No	A list of device names to filter out rows in the ADT view. Define a list of device names. A row matches if the device name in the device column is in the list.
  columns	array	No	To define the returned columns, users need to fill in the display name list for the column. When the value is empty, all columns will be returned.

• Optional Parameters for Advanced Settings
  

  Parameter	Type	Required	Description
  option.rowFilter	object	No	columnName: value Multiple values are combined using AND logic.
  pageSize	int	No	The count of returned entries. The default value is 100.
  pageNumber	int	No	The count of returned pages. The default value is 1.

Sample Request:

Response

The table includes what data can be retrieved by API and how the data will be returned.

ADT Column Type	Return
device	device name
device list	device name1 device name2
interface	device - interface name
interface list	device - interface name1 device - interface name2
string	string
int	string
float	string
bool	string (True/False)
map	map id map name map url
time	4/25/2024 10:00:13 PM, UTC 5
intent	intent name intent id
intent result summary	(m) alert, (n) success
intent status code summary	1st message | number
path	application name path id path name
site	site id site name site full path site map url
ADT Dataset	[device], [cmd list/config], [timestamp]