Interactive Devices 2023.1.x

Internal inventory devices can be added to Itential Automation Gateway (IAG) using the inventory API resource as detailed in the Inventory Sources guide.

Viewing Endpoints and Methods

To view details about various endpoints and methods:

1. Hover your cursor over the menu (≡) button located in the upper-right corner of the side navigation menu. In the menu that appears, click API Documentation. The API Documentation panel opens on the right side of the screen.

   Figure 1: Opening the Interactive API Documentation

   

   
   

2. On the API Documentation panel, available API resources are organized by header. Click the Inventory header to display the methods of the Inventory resource.

3. Click the POST /inventories/http_requests/{inventory_name}/devices method to display detailed information about the method, including:

   • A brief description of the method.
   • Method parameters.
   • A list of responses that can be returned from the related endpoint.
   
   

   Figure 2: HTTP Device Creation Method

   

   
   

Testing Methods

To test the method:

1. Click the Try it out button located to the right of the Parameters header. The request body becomes editable and an Execute button appears.

2. Modify the request body as desired. For more information, refer to the Inventory Integration Variables documentation.

3. Click the Execute button. The endpoint response will be displayed in JSON format.

   Figure 3: Executing a Method