To manage different versions of your compiled API and save them in the database, you use compilation branches. Compilation branches are managed in a separate pane on the start page. Here you can select the compilation branch that you want to use, display the existing compilation branches, create compilation branches, edit compilation branches, and delete compilation branches.
API Designer
Basic principles of API development
Guidelines and conventions
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
API projects
Object properties
Managing objects in a project (solution)
Editing database objects (definition tree view)
Labeling changes
Find and replace
Multilingual captions
Creating multilingual captions
Searching for a multilingual caption
Editing a multilingual caption
Deleting a multilingual caption
Managing database queries
Displaying database queries
Creating a database query
Editing a database query
Testing a database query
Deleting a database query
Managing tabs
Managing layouts
Displaying the change history (command list)
Bookmarks
Compiling an API
Testing a compilation
Starting a compilation
Managing compilation errors and warnings (task window)
Opening the compiling log
Managing versions (compilation branches)
Selecting and using compilation branches
Creating compilation branches
Editing compilation branches
Deleting compilation branches
Testing an API
Linking C# projects to the API Designer
Creating API projects
Editing API projects
Deleting API projects
Configuring authentication
Configuring the compilation
Assigning API files to an API project
Importing API projects
API methods
Creating API files
Editing API files
Deleting API files
Assigning API files to an API project
Importing API files
API Server
ImxClient command line program
Managing versions (compilation branches)
Selecting and using compilation branches
Working with the API Designer > Managing versions (compilation branches) > Selecting and using compilation branches
To select and use compilation branches
-
In the menu bar, click View > Home.
-
On the start page, expand the Compilation branches pane.
-
In the Compilation branches pane, in the Compilation branch identifier list, click the compilation branch that you want to use.
TIP: If you do not want to use a compilation branch, click
(Use main branch).
Related topics
Creating compilation branches
Working with the API Designer > Managing versions (compilation branches) > Creating compilation branches
To use a compilation branch
-
In the menu bar, click View > Home.
-
On the start page, expand the Compilation branches view.
-
In the Compilation branches view, click
Manage name of branches.
-
In the Manage compilation branches window, click
Add.
A new entry Unknown is added at the end of the list.
-
In the list, click Unknown.
-
In the Identifier field, enter a unique name for the compilation branch.
-
(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.
-
Click
(Save).
Related topics
Editing compilation branches
Working with the API Designer > Managing versions (compilation branches) > Editing compilation branches
To edit existing compilation branches
-
In the menu bar, click View > Home.
-
On the start page, expand the Compilation branches pane.
-
In the Compilation branches pane, click
-
In the Manage compilation branches dialog, click the compilation branch that you want to edit in the list.
-
In the Identifier field, enter a unique name for the compilation branch.
-
(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.
-
Click