Endpoint - Delete data record
Step-by-step guide
Proceed as follows to create an API endpoint for the "Delete data record" action:
-
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.
-
Click "Data group endpoint".
-
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.
Note You can change the method or action by clicking the method and then selecting a different action.
Action
Select "Delete data record".
The upper part of the window below "Endpoint" displays the DELETE method and the first part of the path.
Application
Select the application you require.
Data group
Select the data group of your choice.
Click on "Next".
The "Path parameters" page 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.
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 assumes that you are creating a static parameter and the primary key as a path parameter with data field mapping.
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.
Click "Data field (PK) u (S) ID <string>".
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.
You are taken to the "Query parameters" page.
In the following, it is assumed that no query parameter is used for the endpoint described here.
Click on "Finish".
Your next steps
Typically, after you create the API endpoint, you must perform the following actions to be able to execute the API endpoint.