Endpoint - Read multiple data records

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 "Read multiple data records".

The upper part of the window below "Endpoint" displays the GET 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 .

   The options "Variable" and "Static" are displayed.

   

2. Click "Variable" if you want to create a variable path parameter.

   Click "Static" if you want to create a static path parameter.

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

   The input fields for defining the path 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.

   Variable parameter

   If you select this checkbox, the static path parameter becomes a variable path parameter.

   Data type

   Select the data type of the path parameter here.

   The data type of the incoming path parameter must match the data type selected here. If the data types do not match, the respective request will not be processed.

   Description

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

3. Click on "Next".

   The "Query parameters" dialog step appears.

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

Detailed information about query parameters can be found under the following links:

• https://learn.openapis.org/specification/parameters.html

• https://swagger.io/docs/specification/describing-parameters/

1. Click on the .

   The input fields for defining query parameters 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.

   Data type

   Select the data type of the path parameter here.

   The data type of the incoming path parameter must match the data type selected here. If the data types do not match, the respective request will not be processed.

   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.

   Parameter is required

   If you select this checkbox, the parameter is mandatory for the request.

   Activating the checkbox can be helpful, among other things, if a parameter is expected in any case, but a meaningful fallback cannot be defined (for example, a user ID).

   Description

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

2. Click on "Next".

   You are taken to the "Filter and sort" dialog.

 

1. Click on the .

   The "Filter expression properties" dialog is displayed.

   

   The relevant fields are described below.

    

   Data group

   Select the data group to which the query parameter should be assigned here.

   Data Field

   Select the data field to be assigned to the query parameter here.

   Binding

   Select the query parameter here.

   Click on the .

   The "Binding properties" dialog appears.

   Select the "Parameters (Application API)" option on the left.

   Select the desired parameter on the right below "Parameter (Application API)".

   

   Click on "OK".

   You will be returned to the "Filter expression properties" dialog.

   Click on "OK".

   You will be returned to the "Filter and sort" dialog step.

2. Click on "Finish".

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