Starting the API Designer
Before you start developing your API, you must start the API Designer.
To start the API Designer
-
Go to the installation path for API Designer.
-
Run the ApiDesigner.Editor.exe application.
The API Designer opens.
-
Perform one of the following tasks:
-
To use an existing connection to the One Identity Manager database, select it in the Select a database connection menu.
-
To create a new connection to the One Identity Manager database, click Add new connection and enter a new connection.
-
Select the authentication method and enter the login data for the database under Authentication method.
-
Click Connect.
-
In the Select project save type dialog, perform one of the following tasks:
-
(Optional) To save the selected storage type for future projects, select the Use selected project as default option.
-
Click OK.
The API Designer opens and displays the start page.
Related topics
Project types
The API Designer distinguishes between two different project types for saving your changes.
-
Database project: The project will be stored in the database. Your saved changes are visible to others.
-
Solution project: API Designer allows file-based editing of custom objects locally on your own computer. For more information, see Solution projects.
Related topics
Changing the project type
You can save your project as a database project or as a solution project. For more information, see Project types.
To save the project as a database project
-
In the menu bar, click Edit > Set project type.
-
In the Select the project type dialog, click Database project.
-
(Optional) To save the selection and use it the next time you start the API Designer, enable the option Use selected project as default.
TIP: To undo this setting:
-
In the menu bar, click Connection > Settings.
-
Expand the Editor pane in the Global settings dialog.
-
In the Editor pane, select the Ask for project type at each start option.
The next time the program is started, the Select the project type dialog is displayed.
-
Click OK.
To save the project as a solution project
-
In the menu bar, click Edit > Set project type.
-
In the Select the project type dialog, click Solution project.
-
Perform one of the following actions:
-
Click Create solution and use the wizard to create a new solution.
-
Click Load solution and enter the path to an existing solution.
-
Click the solution most recently used.
-
(Optional) To save the selection and use it the next time you start the API Designer, enable the option Use selected project as default.
TIP: To undo this setting:
-
In the menu bar, click Connection > Settings.
-
Expand the Editor pane in the Global settings dialog.
-
In the Editor pane, select the Ask for project type at each start option.
The next time the program is started, the Select the project type dialog is displayed.
-
Click OK.
Related topics
Solution projects
API Designer allows for custom objects to be edited locally in a file-based format on your own computer. To do this you will need to export any custom objects stored within the database to the API Designer. In other words, you must use the "solution project" project type (see Changing the project type).
To import the changes made to the solution project back into the database, follow the instructions in Importing solution project changes into a database.
After exporting these objects from the database, you can edit and remove them on your computer, or supplement them with additional objects. Local object editing is no different than editing within the database project.
During export, any objects contained in the selected module are copied to the hard drive:
Related topics
