API Data Retrieval Management

NetBrain engineers or Power Users can expand and manage the API data available to end users through API Data Category and API Data Retrieval.

The folder structure on the left side of the Select API Data to Retrieval dialog is defined on this API Data Category section.

1. You can expand the Category and API Data for more technologies using the option +New Technology. For example: Expanding Cisco ACI's API Data can be defined in this Category structure.
2. Both Import and Export functionalities are supported.
   

API Data Retrieval

NetBrain engineers will continuously add and adjust API Data, which will be delivered to customers through KC (Knowledge Cloud). Using the API Data Retrieval, the following details are presented to end users in the Select API Data to Retrieve dialog:

• Tree structure on the left side.
• On the right side:
  • Description information, and
  • The UI will dynamically display the API Parameters based on the definition in the backend code, user can adjust it. The input box will perform type validation. For example: If the parameter is an int type, and if the user inputs a string, the input box will have a red inline error prompt.
    
    

  • Hover the mouse on the parameter and to see its description: