Endpoint - Trigger workflow with "POST"

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 "Process endpoint".

3. Click on "Next".

   The "Process selection" 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.

Process

Select the workflow you want to trigger here.

Event handlers

Select the event handler with which the process is to be started here.

Only those generic event handlers are available for selection for which the class de.uplanet.lucy.server.workflow.eventhandler.UserWorkflowEventHandler has been selected.

Click on "OK".

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.

1. Click on "Next".

   The "Request JSON Body" dialog step appears.

1. Click on the .

   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.

   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.

   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.

   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. Enter the parameters.

   These are the parameters that the process requires. The parameters are processed in the processing context of the workflow.

3. Click on "Next".

   The "Response JSON body" dialog step appears.

Here you can enter the parameters that the process should return.

The following assumes that no Response JSON body parameters are used for the endpoint described here.

Click on "Finish".

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