Creating process endpoints

You can use process endpoints to trigger workflows.

A generic event handler with the Java class de.uplanet.lucy.server.workflow.eventhandler.UserWorkflowEventHandler must be selected as the starting point of the process. Otherwise, the process can contain the usual conditions and actions.

You should first create the process and then the process endpoint because the appropriate process and event handler must be selected when creating the process endpoint.

In addition, you can pass parameters to the process with the process endpoint. Consequently, when you are creating the process endpoint, you should know the parameters that the process expects or should receive.

Methods

Note that the specification of the method for process endpoints is (only) of informative value. So, for example, if you use POST, you should do so when the triggered process writes a data record or more generally "creates" something. Or use GET if you want the process to return something.

For process endpoints, specifying the method does not cause any functionality. It (merely) serves to provide the users or consumers of the API with a good understanding of the API endpoint.

The following methods are available for process API endpoints:

• GET

• POST

• PUT

• PATCH

• DELETE

Overview of the next chapters

In the next section, you will first find instructions on how to create a process that can then be triggered with a process endpoint.

Then you will find instructions for creating a process endpoint using the POST method.