Chat now with support
Chat mit 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

Linking C# projects to the API Designer

To edit an API as a C# project with external programs (for example, Visual Studio), perform the following steps:

  1. Link your API Designer project with a new or existing C# project.

  2. Edit the C# project in an external program.

  3. Open the C# project again in API Designer and save it in the API project.

To link the API Designer project with a C# project

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

  2. On the start page, expand the C# development pane.

  3. In the C# development pane, perform one of the following actions:

    • To export and link the API Designer project as a new C# project, click Export C# project. Navigate to the folder where you want to export the content of your API Designer project as a C# project and click OK.

    • To link the API Designer project with an existing project, click Load C# project.

    The API Designer is linked with the C# project.

To edit the C# project in an external program

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

  2. On the start page, expand the C# development pane.

  3. In the C# development pane, click Project file: <path to C# project>.

    The project opens in the program that the project file is linked with.

    TIP: To open the project folder directly, click Open corresponding folder.

  4. Edit the project in the external program. For example, you can create, change, or delete API files.

To save changes back to the API Designer project

  1. Open the API Designer.

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

  3. On the start page, expand the C# development pane.

  4. In the C# development pane, click Synchronize C# project with base.

    You now see the objects that you have changed outside the API Designer.

  5. In the list, next to the changed objects, select the actions that you want to perform for the API Designer project.

    Status message

    Description

    Actions

    New C# file

    A new API file was created in the C# project.

    Add API file: Adds the C# file that you created in the external program to yourAPI Designer project as an API file.

    Delete file: Deletes the C# class in the C# project.

    New API file

    A new API file was created in the API Designer Sharp project.

    Add C# file: Adds the API file that you created in the API Designer to your C# project as a C# file.

    Delete API file: Deletes the API file in the API Designer project.

    API file is newer

    An API file was modified in the API Designer project.

    Update: Transfers the changes to the API file from the API Designer project into the C# project.

    Revert changes: Reverses the changes that you made in your API Designer project in the API file.

    C# file is newer

    An API file was modified in the C# project.

    Update: Transfers the changes to the API file from the C# project into the API Designer project.

    Revert changes: Reverses the changes that you made in your C# project in the API file.

  6. Select the check box next to the objects for which the selected actions should be performed.

    TIP: To quickly select or deselect all objects, select the Select all/deselect all check box above the list.

  7. Click (Apply selected actions).

API projects

An API project represents the actual API application itself.

You can combine API files that you have created in one API project for a logical application. The API project includes the configuration. The API project includes the authentication on the database.

Related topics

Creating API projects

You can create new API projects at any time.

To create 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. Click (Add) > Add API project.

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

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

  7. In the node editor view, configure the following settings.

    Setting

    Description

    General settings

    Identifier

    Enter a unique name for the node.

    Technical abbreviation

    Enter a short name for the API project. This name is used later for the assignment of the project.

    Control-ID

    Enter a unique ID for the node.

    Model version

    Shows the model version being used.

    Workflow control

    Allow extensions to this document

    Enable this option to permit the creation of enhancements to this node.

    Advanced settings

    Required database modules

    (Optional) Enter the database modules required for this API project.

  8. Configure further API project settings (see Configuring authentication for the Operations Support Web Portal and Configuring the compilation).

  9. On the toolbar, click (Save).

Related topics

Editing API projects

You can edit any API projects you have created at any time.

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

To edit 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. Click View > Node editor on the menu bar.

  6. Use the Definition tree view and the Node editor view to configure further API project settings (see Configuring authentication for the Operations Support Web Portal and Configuring the compilation).

  7. On the toolbar, click (Save).

Related topics
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen