You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Besides many useful built-in action templates, JWT offers the possibility to create individual remote actions.

A remote action always refers to a defined connection in which the information about the remote service, such as the URL and the authentication, is configured. In the action, all further configurations are made in order to address an entry point clearly and with the relevant information. This includes, among other things, the relative path of the actual entry point as well as the parameters which are to be used for the query.


Manage actions

A custom remote action can either be created directly within the Execute remote action post function or within the Remote actions page in the Manage apps administration. On the Remote actions page, you can furthermore copy, edit and delete custom actions.


Create an action
Name
Define the name of the action. The name must be unique across all remote actions.
Method
Select the method type that will be used while connecting to the remote service.
Default connection
Select either the current instance or one of the connections to a remote service already configured. Learn more about creating a connection! [LINK]
REST path

Define the relative path to the endpoint to be called by the action. The path will get appended to the configured Base URL in the connection.

In order to make it easier and more powerful to work with the REST path, you can use placeholders for path and query parameters. A path needs to follow the following pattern:

/path/to/my/endpoint/{pathParameter}?{queryParameter1}&{queryParameter2}

A path parameter is every placeholder before the first found question mark character. It will get replaced by runtime with the value set in the further configuration.

If a placeholder is found after the first question mark character, it will get treated as a query parameter. You can configure the placeholder in the further configuration and set a custom value. At runtime, it will get replaced by the default query parameter pattern:

queryParameter1=you custom value
Parameter

If you have defined any placeholders in the REST path, you need to configure how they will get replaced when executing the action. You can set a value either by passing the value of a field to the placeholder or by setting it manually using a Parser expression.

Action body

In case the methods POST or PUT is configured as a method type for the action, a JSON-based action body can be defined and configured. Within the body you can insert as usual field codes and Expression parser functions.

ui ex


Create a custom remote action


Create a connection

Manage