サポートと今すぐチャット
サポートとのチャット

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

Deleting API projects

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

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

To delete 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, click on the API project to be deleted.

  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

Importing API projects

You can import API projects into the API Designer. The API Designer independently detects whether the projects are API projects, and imports them as such.

To import an API project

  1. Start the API Designer program.

  2. In the menu bar, click Edit > Import object.

  3. In the file browser, select the required API project and click Open.

    The API project is imported.

Related topics

API methods

You can use an API method to create a call for exchanging data with the server (or database) relating to a specific application scenario. An API method can belong to more than one project. In an API method, you can define an API method, for example.

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

Using the API Designer, you can define the following types of API methods in API methods

Entity methods

Entity methods work with small parts of the object model in order to read data from the database or write data to the database. When you create an entity method, you only need to enter the table and column name and, if required, a filter condition (WHERE clause). Internal processing is handled by the API Server. The data schema for the input and output also has a specific format.

For examples for the definition of entity methods, see the SDK under Sdk01_Basics\01-BasicQueryMethod.cs.

User-defined methods

User-defined methods are methods for which you fully define the processing, input, and output data in code. This type therefore offers the greatest flexibility.

For examples for the user-defined methods, see the SDK under Sdk01_Basics\03-CustomMethod.cs.

SQL methods

SQL methods are methods that provide data from a predefined SQL query through the API. Create the parameters of a query as SQL parameters.

For examples for the definition of SQL methods, see the SDK under Sdk01_Basics\02-BasicSqlMethod.cs.

Related topics
関連ドキュメント

The document was helpful.

評価を選択

I easily found the information I needed.

評価を選択