立即与支持人员聊天
与支持团队交流

Identity Manager 8.2.1 - API Development Guide

Basic principles of API development Examples and help – Software Development Kit API configuration Implementing your own APIs API Designer Quick start – Creating an API with the API Designer 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 methods 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. Start the API Designer program.

  2. In the menu bar, click View > Navigation.

  3. In the navigation, click API files.

  4. Click Add > Add API file.

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

  6. 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. Start the API Designer program.

  2. In the menu bar, click View > Navigation.

  3. In the navigation, click API files.

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

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

  6. 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. Start the API Designer program.

  2. In the menu bar, click View > Navigation.

  3. In the navigation, click (API files).

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

  5. Click (Delete).

  6. Confirm the prompt with Yes in the dialog.

  7. 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. Start the API Designer program.

  2. In the menu bar, click View > Navigation.

  3. Click API projects in the navigation.

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

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

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

    The new API file reference node is added.

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

  8. Click View > Node editor on the menu bar.

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

  10. Select the required file in the Name list.

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

  11. On the toolbar, click (Save).

Related topics
相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级