Chat now with support
Chat with Support

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

To use a compilation branch

  1. In the menu bar, click View > Home.

  2. On the start page, expand the Compilation branches view.

  3. In the Compilation branches view, click Manage name of branches.

  4. In the Manage compilation branches window, click Add.

    A new entry Unknown is added at the end of the list.

  5. In the list, click Unknown.

  6. In the Identifier field, enter a unique name for the compilation branch.

  7. (Optional) In the Description field, enter a description for the compilation branch. This description may explain, for example, the intended purpose of the compilation branch.

  8. Click (Save).

Related topics

Editing compilation branches

To edit existing compilation branches

  1. In the menu bar, click View > Home.

  2. On the start page, expand the Compilation branches pane.

  3. In the Compilation branches pane, click Manage compilation branches.

  4. In the Manage compilation branches dialog, click the compilation branch that you want to edit in the list.

  5. In the Identifier field, enter a unique name for the compilation branch.

  6. (Optional) In the Description field, enter a description for the compilation branch. This description may explain, for example, the intended purpose of the compilation branch.

  7. Click (Save).

Related topics

Deleting compilation branches

To delete compilation branches

  1. In the menu bar, click View > Home.

  2. On the start page, expand the Compilation branches pane.

  3. In the Compilation branches pane, click Manage compilation branches.

  4. In the Manage compilation branches dialog window, click the compilation branch that you want to delete from the list.

  5. Click (Delete).

  6. Confirm the Delete? prompt by selecting Yes.

Related topics

Testing an API

You can test the functionality of your API locally on your PC at any time.

To test your API locally

  1. In the menu bar, click View > Home.

  2. Expand the Self-hosted API Server pane on the start page.

  3. In the Startup options field, enter the options for starting the API.

    TIP: Alternatively, you can also select previous commands from the list.

  4. Click Start.

    The API is compiled and will then be available locally. The corresponding web address is displayed next to the Status. Click the address to open this directly in the browser.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating