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

Compare with Current View Page History

« Previous Version 6 Next »

Use this function to execute a JWT remote action.

Syntax
executeRemoteAction(actionName) #Output: Text
Examples
Parser expressionDescription
executeRemoteAction("Great action")

This example executes the action called "Great action" and returns the whole JSON response.

Additional information

Parameters used in this function

ParameterInput (data type)Description
actionName

TEXT

Name of the action to execute (case sensitive)
Output

The function returns a TEXT representing the following JSON.



Variant where you can specify a jmes path.

Syntax
executeRemoteAction(actionName, jmes) #Output: Text
Examples
Parser expressionDescription
executeRemoteAction("Great action", "body")

This example executes the action called "Great action" and returns only the body part of the JSON response.

executeRemoteAction("Great action", "body.data")

This example executes the action called "Great action" and returns only the data part of the JSON response's body object.

executeRemoteAction("Great action", "status")

This example executes the action called "Great action" and returns only the status code of the JSON response.

Additional information

Parameters used in this function

ParameterInput (data type)Description
actionName

TEXT

Name of the action to execute (case sensitive)
jmes

TEXT

A valid JMES path to retrieve only specific data from the returned json object
Output

The function returns a TEXT representing the following JSON (depending on the provided jmes path):

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}



Variant where you can specify additional parameters.

Syntax
executeRemoteAction(actionName, parameterList) #Output: Text
Examples
Parser expressionDescription
executeRemoteAction("Great action", ["query": "Demo", "path": "projects"])

This example executes the action called "Great action" and returns the whole json response. In addition, the parameters "query" and "path" will be added to the request.

executeRemoteAction("POST action", ["body": "{\"userId\": 12, \"name\": \"John Doe\"}"])

This example executes the action called "POST action" and returns the whole json response. In addition, the action's request body will be populated with the provided JSON.

Additional information

Parameters used in this function

ParameterInput (data type)Description
actionName

TEXT

Name of the action to execute (case sensitive)
parameterList

PARAMETER LIST

The parameter list's syntax is ["key": "value", "key2": "anotherValue", "key3": 12, ...].

The key must always be a text and unique within the parameter list.

The value can be of type text or number. It is also possible to enter there parser expressions that return either a text or a number.

The parameter list can be used to overwrite parameters set in the action configuration like the following:

  • If a key/ value pair is defined in the list and there is a query param with that key, the value for that param will be overwritten by the paramter list's value
  • If a key/ value pair is defined in the list and there is a path param with that key, the value for that param will be overwritten by the parameter list's value
  • If a key/ value pair is defined in the list and there is neither a query or path param with that key, this pair will be added as additional query param to the request
  • If the key is "body" and there is neither a query or path param with that key, this parameter will be used to set the action body
Output

The function returns a TEXT representing the following JSON:

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}



Variant where you can specify additional parameters and another connection.

Syntax
executeRemoteAction(actionName, parameterList, connectionName) #Output: Text
Examples
Parser expressionDescription
executeRemoteAction("Great action", ["query": "Demo", "path": "projects"], "Some other connection")

This example executes the action called "Great action" and returns the whole json response. In addition, the parameters "query" and "path" will be added to the request and the connection called "Some other connection" is being used.

Additional information

Parameters used in this function

ParameterInput (data type)Description
actionName

TEXT

Name of the action to execute (case sensitive)
parameterList

PARAMETER LIST

The parameter list's syntax is ["key": "value", "key2": "anotherValue", "key3": 12, ...].

The key must always be a text and unique within the parameter list.

The value can be of type text or number. It is also possible to enter there parser expressions that return either a text or a number.

The parameter list can be used to overwrite parameters set in the action configuration like the following:

  • If a key/ value pair is defined in the list and there is a query param with that key, the value for that param will be overwritten by the paramter list's value
  • If a key/ value pair is defined in the list and there is a path param with that key, the value for that param will be overwritten by the parameter list's value
  • If a key/ value pair is defined in the list and there is neither a query or path param with that key, this pair will be added as additional query param to the request
  • If the key is "body" and there is neither a query or path param with that key, this parameter will be used to set the action body
connectionName

TEXT

Name of the connection to use for the action (case sensitive)
Output

The function returns a TEXT representing the following JSON:

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}



Variant where you can specify a jmes path and additional parameters.

Syntax
executeRemoteAction(actionName, jmes, parameterList) #Output: Text
Examples
Parser expressionDescription
executeRemoteAction("Great action", "body.data", ["query": "Demo", "path": "projects"])

This example executes the action called "Great action" and returns only the data part of the response's body. In addition, the parameters "query" and "path" will be added to the request and the connection called "Some other connection" is being used.

Additional information

Parameters used in this function

ParameterInput (data type)Description
actionName

TEXT

Name of the action to execute (case sensitive)
jmes

TEXT

A valid JMES path to retrieve only specific data from the returned json object
parameterList

PARAMETER LIST

The parameter list's syntax is ["key": "value", "key2": "anotherValue", "key3": 12, ...].

The key must always be a text and unique within the parameter list.

The value can be of type text or number. It is also possible to enter there parser expressions that return either a text or a number.

The parameter list can be used to overwrite parameters set in the action configuration like the following:

  • If a key/ value pair is defined in the list and there is a query param with that key, the value for that param will be overwritten by the paramter list's value
  • If a key/ value pair is defined in the list and there is a path param with that key, the value for that param will be overwritten by the parameter list's value
  • If a key/ value pair is defined in the list and there is neither a query or path param with that key, this pair will be added as additional query param to the request
  • If the key is "body" and there is neither a query or path param with that key, this parameter will be used to set the action body
Output

The function returns a TEXT representing the following JSON (depending on the provided jmes path):

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}



Variant where you can specify a jmes path and another connection.

Syntax
executeRemoteAction(actionName, jmes, connectionName) #Output: Text
Examples
Parser expressionDescription
executeRemoteAction("Great action", "body.data", "Different connection")

This example executes the action called "Great action" and returns the whole JSON response. In addition, the connection called "Different connection" is being used.

Additional information

Parameters used in this function

ParameterInput (data type)Description
actionName

TEXT

Name of the action to execute (case sensitive)
jmes

TEXT

A valid JMES path to retrieve only specific data from the returned json object
connectionName

TEXT

Name of the connection to use for the action (case sensitive)
Output

The function returns a TEXT representing the following JSON (depending on the provided jmes path):

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}



Variant where you can specify a jmes path, a connection and additional parameters.

Syntax
executeRemoteAction(actionName, jmes, connectionName, parameterList) #Output: Text
Examples
Parser expressionDescription
executeRemoteAction("Great action", "body.data", "cool connection", ["query": "Demo", "path": "projects"])

This example executes the action called "Great action" and returns only the data part of the response's body. In addition, the parameters "query" and "path" will be added to the request and the connection called "cool connection" is being used.

Additional information

Parameters used in this function

ParameterInput (data type)Description
actionName

TEXT

Name of the action to execute (case sensitive)
jmes

TEXT

A valid JMES path to retrieve only specific data from the returned json object
connectionName

TEXT

Name of the connection to use for the action (case sensitive)
parameterList

PARAMETER LIST

The parameter list's syntax is ["key": "value", "key2": "anotherValue", "key3": 12, ...].

The key must always be a text and unique within the parameter list.

The value can be of type text or number. It is also possible to enter there parser expressions that return either a text or a number.

The parameter list can be used to overwrite parameters set in the action configuration like the following:

  • If a key/ value pair is defined in the list and there is a query param with that key, the value for that param will be overwritten by the paramter list's value
  • If a key/ value pair is defined in the list and there is a path param with that key, the value for that param will be overwritten by the parameter list's value
  • If a key/ value pair is defined in the list and there is neither a query or path param with that key, this pair will be added as additional query param to the request
  • If the key is "body" and there is neither a query or path param with that key, this parameter will be used to set the action body
Output

The function returns a TEXT representing the following JSON (depending on the provided jmes path):

{
	"status": 200 // Returned status code from the executed action
	"body": any // Response body that was returned from the executed action
}