Chat now with support
Chat with Support

We are currently experiencing issues on our phone support and are working diligently to restore services. For support, please sign in and create a case or email supportadmin@quest.com for assistance

Identity Manager 8.1.4 - API Designer User and Development Guide

API Designer Basic principles of API development Examples and help – Software Development Kit Quick start – Creating an API Working with the API Designer
Starting the API Designer Project types User interface Global settings Database objects Labeling changes Find and replace Multilingual captions Managing database queries Managing tabs Managing layouts Displaying the change history (command list) Bookmarks Compiling an API Managing versions (compilation branches) Testing an API Linking C# projects to the API Designer
API projects API files API Server ImxClient command line program

Creating API files

You can create new API files at any time.

NOTE: If you create a new API file to provide a new API method, you must name the API file the same as the class. Ensure you use the correct case.

To create an API file

  1. On the menu bar, click View | Navigation.

  2. In the navigation, click API files.

  3. Click Add | Add API file.

  4. In the new window, create the file definition.

  5. On the toolbar, click Save.

Related topics

Editing API files

You can edit the API files you have created at any time.

NOTE: You cannot edit API files that have been predefined by the API Designer.

To edit an API file

  1. On the menu bar, click View | Navigation.

  2. In the navigation, click API files.

  3. In the tree structure, click the API file that you want to edit.

  4. In the new window, create the file definition.

  5. On the toolbar, click Save.

Related topics

Deleting API files

You can delete the API files you have created at any time.

NOTE: You cannot delete API files that have been predefined by API Designer.

To delete an API file

  1. On the menu bar, click View | Navigation.

  2. In the navigation, click API files.

  3. In the tree structure, click the API file that you want to delete.

  4. Click Delete.

  5. Confirm the prompt by selecting Yes in the dialog.

  6. Click Reload data in the tree structure.

Related topics

Assigning API files to an API project

In order for the API files you have created to be used practically, they must be assigned to an API project.

To assign API files to an API project

  1. On the menu bar, click View | Navigation.

  2. In the navigation, click API projects.

  3. In the tree structure, double-click the API project to be edited.

  4. In the definition tree view, right-click the topmost node.

  5. In the context menu, click API file reference.

    The new API file reference node is added.

  6. In the definition tree view, click API file reference.

  7. Click View | Node editor on the menu bar.

  8. In the node editor view, enter a unique ID for the node into the Control ID field.

  9. Select the required file in the Name list.

    TIP: To skip directly to the file definition, click Show definition object.

  10. On the toolbar, click Save.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating