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 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

Importing API files

You can import API files into the API Designer. The API Designer automatically detects that the files are API files and imports them as such.

To import an API file

  1. Click Edit | Import object on the menu bar.

  2. In the file browser, select the API file and click Open.

    The API file is imported.

Related topics

API Server

The API that you created in the API Designer is available in the API Server.

To call the API Server web interface

  • In a web browser, open the web address (URL) of your API Server.

    From here, you can:

    • Call the swagger documentation for your API.

    • Open the Operations Support Web Portal.

    • Call all installed HTML5 applications.

ImxClient command line program

The ImxClient command line tool can be used to execute all API Designer API functions from a command line without a graphical interface.

Related topics

Starting the ImxClient command line program

You can start the ImxClient command line tool at any time using any command line interface.

To start the lmxClient command line program

  1. Open a command line interface (for example, Windows Powershell).

  2. In the command line program, go to the installation path for the API Designer.

  3. Run the ImxClient.exe application.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating