Endpoint - Running a Groovy script with "POST"

Step-by-step guide

Proceed as follows to run a Groovy script using the POST method:

  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 on "Groovy endpoint".

  3. Click on "Next".

    The "Groovy script" dialog step appears.

Endpoint

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

Action

Select "POST"

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

Groovy script

  1. Click on the icon.

    The Groovy file manager is displayed.

  2. Create a Groovy script or import an existing script.

    Detailed information about the dialog can be found in the section Groovy file manager.

  3. 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 "Variable" if you want to create variable path parameters.

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

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

  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.

    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.

  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.

Click on "Finish".

JSON-BODY

The dialog steps for creating a JSON body are not available for Groovy endpoints. You must integrate a corresponding response body or request body into the Groovy script.

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

Your next steps

Typically, after you create the API endpoint, you must perform the following actions to be able to execute the API endpoint.

1. Assigning permissions

2. Create and manage API keys

3. Create Swagger documentation