Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


UI Text Box
typeinfo

Besides In addition to 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 clearly address an entry point and with the relevant information clearly. This includes, among other things, the relative path of the actual entry point as well as and the parameters which are to be used for the query.

...

UI Expand
expandedtrue
titleCustom remote actions

A custom remote action can either be directly created 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.


expanded
UI Expand
truetitleCreate an action


UI Expand
titleName
Define the name of the action. The name must be unique across all remote actions.


UI Expand
titleMethod
Select the HTTP method type that will be used while connecting to the remote service.


UI Expand
titleDefault connection
Select either the current instance or one of the already connections to a remote service already configured. Learn more about creating a connection! [LINK]


UI Expand
titleREST path

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

In order to 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 conform the following pattern:

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

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

If a placeholder is found after the first question mark

character

, it will

get

be 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:

Code Block
queryParameter1=you custom With the configuration 

pathParameter : "extended"
queryParameter1 : "my"
queryParameter2 : "value"

the example above will get evaluated to: 

/path/to/my/endpoint/extended?queryParameter1=my&queryParameter2=value



UI Expand
titleParameter

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


UI Expand
titleAction body

In case A JSON-based action body can be defined and configured if one of 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 . You can insert usual field codes and Expression parser functions within the body.



UI Expand
titleEdit an action

On the Remote actions page in the Manage apps administration, you are able to edit an action by just clicking the edit icon of the remote action that you want to update.


UI Expand
titleCopy an action

On the Remote actions page in the Manage apps administration, you are able to copy an action by just clicking the copy icon of the remote action that you want to copy. All configurations are taken over. As the name has to be unique across all remote actions, you have to at least update the action name parameter. 


UI Expand
titleDelete an action

On the Remote actions page in the Manage apps administration, you are able to delete an action by just clicking the delete icon of the remote action that you want to delete. Please keep in mind that deleting an action might result in an invalid workflow configuration if it is still in use.



UI Expand
expandedtrue
titleConnections

Every Each remote action uses a connection to which the request will be is sent to. This can either be an internal connection that can be used helps to overcome some platform limitations or an external one. Those These connections can be created directly within the Execute remote action post function or within on the Remote actions page at the Connections tab in the Manage apps administration. There, you can furthermore copy, edit and delete the connections or get information on whether they are used or not.


UI Expand
expandedtrue
titleCreate a connection


UI Expand
titleName
Define the name of the connection. The name must be unique across all configured connections.


UI Expand
titleConnection type

Select whether to create an internal or an external connection. Although there is a always usable default internal connection using the executing user for the authenticationauthenticated as the logged-in user, you can create further internal connections with a dedicated authentication.


Info

Expert tip: On the cloud platform, not all REST endpoints are available for a 3rd party app like Jira Workflow Toolbox. If you want to use such an endpoint, you can overcome this limitation by creating an external connection using the current site URL and passing the authentication of a privileged user instead of using the internal one.



UI Expand
titleBase urlURL
If the connection is configured as an external connection, the base url URL of the remote service needs to be defined. The base url have URL has to start with http or https and will get be concatenated with the REST path , configured in the action when executing the action.


UI Expand
titleAuthentication

Select the authentication used for the connection.

OptionConnection typeDescription
Current userCurrent instanceThe executing logged-in user will be used to execute the remote action.
Selected userCurrent instanceIndependent of the executing logged-in user, the selected user be used to execute will be the one executing the remote action.
No authenticationExternalNo authentication details will be passed when executing the remote action. This option can be used to connect to access anonymous accessible web services.
BasicExternalA combination of username and password combination will be used to execute the remote action.
BearerExternalAn API token will be passed when executing the remote action.


UI Expand
titleCustom headers

Add custom headers for the connection.

OptionDescription
NameA proper name to describe the header.
Value

You can choose between:

  • Get field value from the current issue
  • Set field value manually (by passing a parser expression (tick) )
UI Text Box
typetip
The header setup overwrites the Authentication configuration (from the previous section) in case of setting the Authorization header.


UI Expand
titleEdit a connection

On the Remote actions page at the Connections tab in the Manage apps administration , you are able to edit a connection by just clicking the edit icon on the connection that you want to update.


UI Expand
titleCopy a connection

On the Remote actions page at the Connections tab in the Manage apps administration , you are able to copy a connection by just clicking the copy icon on the connection that you want to copy. Most configurations are taken over except the credentials in case of an external connection. As the name has to be unique across all remote connections, you have to update at least the connection name parameter. 


UI Expand
titleDelete a connection

On the Remote actions page at the Connections tab in the Manage apps administration , you are able to delete a connection by just clicking the delete icon on the connection that you want to delete. If the connection is used in any connection as a default connection, you need to update the affected actions first. Please keep in mind that deleting a connection might result in an invalid workflow configuration in case it is still in use.