Application sources

Edit online

You can add, edit, or refresh application sources to store them in a vector database as embeddings so that the Visual Studio Code extension plug-in can search for APIs.

About this task

You must have administrator and API Agent user permissions to view the API Agent tab and access the API Agent sources page. For more information, see API Agent user roles .

You can do the following actions to configure the list of application sources under each application objects:

Procedure

  • To add a application sources, you need to provide the necessary connection information for the application, including a name, location, and credentials. After you provide the connection information, the system add an application source to make available for use in your APIs. To add an application source, complete the following steps:
    1. In API Manager, click Settings > API Agent.
    2. In the Application sources section, click Add.
      Note: API Agent now supports usage of multiple applications.
    3. In the Application connection page, select the required application and enter the necessary details, and then click Next.
    4. In the Application objects page, select the objects, and then click Next.
    5. Optional: To create auto refresh settings, set Auto Refresh to On.
    6. Select the required auto refresh frequency, and click Add.
  • To modify the object list, complete the following steps:
    1. In API Manager, click Settings > API Agent.
    2. In the Application sources section, click overflow menu, then click Edit object list.
    3. In the Edit objects page, select the checkbox to add or remove the object.
    4. Click Save.
  • To reflect any changes that were made in the backend, the Refresh option updates the application source. For example, if you added or deleted any fields in the object list, refresh the object to show the most recent updates. To refresh the application, click overflow menu, then click Refresh.
  • To auto refresh, complete the following steps:click overflow menu, then click Auto refresh settings.
    1. Click overflow menu, then click Auto refresh settings.
    2. In the schedule refresh dialog box, set Auto Refresh to On.
    3. Select the refresh frequency, and then click Save.
  • To edit the fields in the Application connection window, use the Edit connection option and complete the following steps:
    1. In API Manager, click Settings > API Agent.
    2. In the Application sources section, click overflow menu, then click Edit connection.
    3. In the Application connection page, update the connection details as necessary.
    4. Click Next.
  • When you remove an application source, you remove it from the API Manager UI and from the backend, which means that the data is inaccessible. To remove an application source, complete the following steps:
    1. In API Manager, click Settings > API Agent.
    2. In the Application sources section, click overflow menu, then click Remove.