Endpoint - Read individual 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 "Read individual data record".

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.

In this dialog step 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 "Data field (PK) u (S) ID <string>".

   (Since only one data record is read, only the primary key is available as a selection option.)

   

   The parameter is displayed with a green background in the left area of the page.

   In the right area you can change or add information.

   

   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.

   Mapping

   Mapping is inactive because only the data field "(PK)(S) ID <string>" is available as a possible selection.

   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.

If you have selected the "Read individual data record" action and have already defined a path parameter, there is no need to define a query parameter.

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

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

Click on "Finish".

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