Use the Compilation settings node in the definition tree view to configure the settings for compiling the API.
If you want to use code from other DLLs in your API code (for example, API files from other projects), you need to create an assembly reference so that the compiler recognizes these DLLs.
To create an assembly reference
-
On the menu bar, click View | Navigation.
-
Click 
API projects in the navigation.
-
In the tree structure, double-click the API project to be edited.
-
In the definition tree view, right-click the Compilation settings node.
-
In the context menu, click Assembly reference.
The Assembly reference node is added under this node.
-
In the definition tree view, click Assembly reference.
-
Click View | Node editor on the menu bar.
-
In the node editor view, enter the name of the assembly you wish to reference into the Referenced assembly field.
-
Click 
Save on the toolbar.
Related topics
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
-
On the menu bar, click View | Navigation.
-
In the navigation, click API projects.
-
In the tree structure, double-click the API project to be edited.
-
In the definition tree view, right-click the topmost node.
-
In the context menu, click API file reference.
The new API file reference node is added.
-
In the definition tree view, click API file reference.
-
Click View | Node editor on the menu bar.
-
In the node editor view, enter a unique ID for the node into the Control ID field.
-
Select the required file in the Name list.
TIP: To skip directly to the file definition, click 
Show definition object.
-
On the toolbar, click 
Save.
Related topics
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
-
Click Edit | Import object on the menu bar.
-
In the file browser, select the required API project and click Open.
The API project is imported.
Related topics
You can use an API file to create a call for exchanging data with the server (or database) relating to a specific application scenario. An API file can belong to more than one project. In an API file, you can define an API method, for example.
NOTE: If you create a new API file to provide a new API method, you must name the API file the same as the class. Ensure you use the correct case.
You can use the API Designer to create the following API files.
Entity files
Entity files 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 file, 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 files, see the SDK under Sdk01_Basics\01-BasicQueryMethod.cs.
C# files
C# files are files for which you fully define the processing, input, and output data in code. This type therefore offers the greatest flexibility.
For examples for the definition C# files, see the SDK under Sdk01_Basics\03-CustomMethod.cs.
SQL files
SQL files are files 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 files, see the SDK under Sdk01_Basics\02-BasicSqlMethod.cs.
Related topics
