API Interfaces Overview

The API Interface menu option is the tenth item in the Define menu. Selecting this option opens the API Interface List dialog box.

From this dialog box, you can edit, copy, and delete existing API interfaces, or add new ones.

Reference Filter

This filter allows the user to display All, Unused, or Used objects in the List.

Add

Clicking Add opens the Edit Interface dialog box.

Edit

Use the Edit button to modify existing API interfaces. To edit an API interface, you must select one from the API interface list and click Edit. Selecting this option opens the API Interface Properties dialog box. You can then edit any item on this dialog box.

Copy

This option allows you to make a copy of an API interface.

Delete

Use delete to remove a Genesys Agent Scripting API Interface from the list.

To delete an API Interface, you must select an API interface from the API Interface List and click Delete. A confirmation message will appear.

When you select Yes, Genesys Agent Scripting will first verify that the API interface to be deleted is not used anywhere in the system. If the API interface is not being used anywhere else, it will be deleted. However, if any other object references the API interface, you will not be able to delete it at this time and a message will appear.

Until all of the references are removed, you cannot delete the API interface. Double-clicking on each reference will take the user to the selected object.

You may select multiple API Interfaces to be deleted by holding the Shift key while selecting the API Interfaces.