Endpoint - Create data record

1. Click (Create new endpoint).

   The "General" dialog step appears.

   

   Name

   Enter a name for the endpoint here.

   The name must be unique, consist of at least two characters and start with a letter. Only alphanumeric characters, hyphens, underscores and periods are allowed.

   Description

   Enter a description for the endpoint here. Multiline texts are possible.

2. Click "Data group endpoint".

3. Click on "Next".

   The "Data group selection" dialog step appears.

Endpoint

The method of the endpoint and the fixed part of the endpoint path are displayed here.

Action

Select "Create data record".

The upper part of the window below "Endpoint" displays the POST method and the first part of the path.

Application

Select the application you require.

Data group

Select the data group of your choice.

Return values of the query

Here you define which values the endpoint should return.

By default (except for "Delete record") the PK (Primary Key) of the data record is already added as a return value.

1. Click to add more return values.

   

   Select/remove all data fields You can press the right mouse button in the "Add data fields" dialog. After that, a window will be displayed in which you can add or remove all the data fields.

   

    

   Remove return values You can remove return values directly by clicking the X that appears next to a return value when you place the mouse over it.

   

   

   Title, Description

   When you click on a return value, the name of the return value is displayed in the right pane.

   From Wiki: Since JSON-compliant identifiers are needed here, the field name can be overwritten.

   You can change the name of the return value. The name must be at least two characters long and begin with a lowercase letter. In addition, it must contain only alphanumeric characters and underscores.

2. Click on "Next".

   The "Path parameters" dialog step appears.

On this page you can define path parameters for the endpoint.

General information on defining path parameters can be found in the section Defining path parameters.

1. Click on the .

   

2. Click on "Data field" if you want to assign the path parameters to a data field.

   Click "Static" if you want to create static path parameters.

   The following steps assume that you are creating a static path parameter.

   The values are later transferred as a JSON object in the "Request JSON body" dialog step.

3. Click "Static".

   The input fields for the parameter are active.

   

   Name

   Enter a name for the parameter here.

   The name may occur only once in an endpoint.

   The name must correspond to this regular expression: [a-zA-Z][a-zA-Z\\d-_.]+ In other words, it must be at least two characters long and start with a letter. Only letters, numbers, hyphens, underscores and periods are allowed.

   Mapping

   Do not make any assignment, as this is a static parameter.

   Description

   Enter a description for the parameter here. Multiline texts are possible. The description is part of the Swagger documentation.

4. Click on "Next".

   The "Query parameters" dialog step appears.

In the following, it is assumed that no query parameter is used for the endpoint described here.

1. Click on "Next".

   The "Request JSON Body" dialog step appears.

1. Click on the .

   The data fields you can select for the request are displayed.

   

2. Click on the .

   The data fields you can select for the request are displayed.

3. Select the desired data fields.

   The JSON body and the parameters are displayed.

   

   Name

   You can change the name of the parameter.

   The name must be at least two characters long and begin with a lowercase letter. In addition, it must contain only alphanumeric characters and underscores.

   Fallback

   Here you can store a fallback value for the parameter.

   The fallback value is used if the parameter is to be evaluated in any case and at the same time a value for the parameter is not mandatory when calling the endpoint.

   Description

   Enter a description for the parameter here. Multiline texts are possible. The description is part of the Swagger documentation.

4. Click on "Finish".

The endpoint that is created is displayed in the "API Endpoints" area.